NomadNet/README.md
2021-03-27 10:58:13 +01:00

29 lines
822 B
Markdown
Executable File

Nomad Network
==========
General introduction to Nomad Network
Nomad Network is built using Reticulum, see [unsigned.io/projects/reticulum](https://unsigned.io/projects/reticulum/).
## Notable Features
- List of notable features
- More features
## Dependencies:
- Python 3
- RNS
- LXMF
## How do I get started?
The easiest way to install Nomad Network is via pip:
```bash
# Install Nomad Network and dependencies
pip3 install nomadnet
# Run the client
nomadnet
```
## Caveat Emptor
Nomad Network is experimental software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it _has not_ been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.