From 5561205b3e0a07a3eab9498425b42ca0d5c81251 Mon Sep 17 00:00:00 2001 From: Sudo-Ivan Date: Wed, 28 May 2025 16:39:15 -0500 Subject: [PATCH] update --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e04b182..a860713 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,7 @@ A simple way to serve pages and files over the [Reticulum network](https://retic ## Usage ```bash -pip install git+https://github.com/Sudo-Ivan/rns-page-node.git - -# or - -pipx install git+https://github.com/Sudo-Ivan/rns-page-node.git +pip install rns-page-node ``` ```bash @@ -56,9 +52,9 @@ make wheel make docker-wheels ``` -## Page formats +## Pages -- Micron `.mu` +Supports Micron `.mu` and dynamic pages with `#!` in the micron files. ## Options @@ -69,12 +65,11 @@ make docker-wheels -f, --files-dir: The directory to serve files from. -i, --identity-dir: The directory to persist the node's identity. -a, --announce-interval: The interval to announce the node's presence. +-r, --page-refresh-interval: The interval to refresh pages. +-f, --file-refresh-interval: The interval to refresh files. +-l, --log-level: The logging level. ``` -## To-Do - -- [ ] Pypi - ## License This project incorporates portions of the [NomadNet](https://github.com/markqvist/NomadNet) codebase, which is licensed under the GNU General Public License v3.0 (GPL-3.0). As a derivative work, this project is also distributed under the terms of the GPL-3.0. See the [LICENSE](LICENSE) file for full license.