RNS-Things/rns-page-node
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Sudo-Ivan
2025-05-28 16:39:15 -05:00
parent d6601adb38
commit 5561205b3e
1 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -5,11 +5,7 @@ A simple way to serve pages and files over the [Reticulum network](https://retic
## Usage ## Usage
```bash ```bash
pip install git+https://github.com/Sudo-Ivan/rns-page-node.git pip install rns-page-node
# or
pipx install git+https://github.com/Sudo-Ivan/rns-page-node.git
``` ```
```bash ```bash
@@ -56,9 +52,9 @@ make wheel
make docker-wheels make docker-wheels
``` ```
## Page formats ## Pages
- Micron `.mu` Supports Micron `.mu` and dynamic pages with `#!` in the micron files.
## Options ## Options
@@ -69,12 +65,11 @@ make docker-wheels
-f, --files-dir: The directory to serve files from. -f, --files-dir: The directory to serve files from.
-i, --identity-dir: The directory to persist the node's identity. -i, --identity-dir: The directory to persist the node's identity.
-a, --announce-interval: The interval to announce the node's presence. -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 ## 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. 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.