Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-23 16:28:12 -07:00
Code Issues Packages Projects Releases Wiki Activity

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
docs/source/index.rst
-12
View File
@@ -5,8 +5,6 @@ Welcome to the manual for Reticulum. This document aims to provide you
with all the information you need to understand Reticulum, develop programs
using it, or to participate in the development of Reticulum itself.
Table of Contents
=================
.. toctree::
:maxdepth: 3
@@ -17,16 +15,6 @@ Table of Contents
understanding
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.
Indices and Tables
==================