Reticulum/docs/source/index.rst

35 lines
1.3 KiB
ReStructuredText
Raw Normal View History

******************************
Reticulum Network Stack Manual
******************************
Welcome to the manual for Reticulum. This document aims to provide you
2021-05-16 19:58:11 +00:00
with all the information you need to understand Reticulum, develop programs
using it, or to participate in the development of Reticulum itself.
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
Table of Contents
=================
2021-05-16 15:36:50 +00:00
.. toctree::
:maxdepth: 3
2021-05-16 19:58:11 +00:00
whatis
2021-05-16 17:18:21 +00:00
gettingstartedfast
examples
2021-05-16 15:36:50 +00:00
reference
2021-05-16 19:58:11 +00:00
understanding
Current Status
==============
2021-05-16 21:50:49 +00:00
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.
2021-05-16 19:58:11 +00:00
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.
2021-05-16 15:36:50 +00:00
2021-05-16 19:58:11 +00:00
Indices and Tables
2021-05-16 15:36:50 +00:00
==================
* :ref:`genindex`
* :ref:`search`