Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-09-20 04:34:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated documentation

Browse source
This commit is contained in:
Mark Qvist 2021-05-17 17:04:01 +02:00
parent 7176fdb71d
commit eb0c40295f
12 changed files with 331 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/whatis.rst
View file

@ -9,6 +9,16 @@ Reticulum is a complete networking stack, and does not use IP or higher layers,
No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3.
Current Status
==============
Reticulum should currently be considered beta software. All core protocol features are implemented and functioning, but additions will probably occur as real-world use is explored. There will be bugs. The API and wire-format can be considered relatively stable at the moment, but could change if warranted.
Caveat Emptor
==============
Reticulum 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. To be considered secure, Reticulum needs a very thourough security review by independt cryptographers and security researchers. If you want to help out, or help sponsor an audit, please do get in touch.
What does Reticulum Offer?
==========================
* Coordination-less globally unique adressing and identification