William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-22 21:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme and documentation

Browse Source
This commit is contained in:
Mark Qvist 2022-09-29 23:20:49 +02:00
parent 8886ed5794
commit e90b2866b4
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -59,7 +59,7 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects
- The API is very easy to use, and provides transfer progress - The API is very easy to use, and provides transfer progress
- Lightweight, flexible and expandable Request/Response mechanism - Lightweight, flexible and expandable Request/Response mechanism
- Efficient link establishment - Efficient link establishment
- Total bandwidth cost of setting up an encrypted link is 3 packets totaling 265 bytes - Total bandwidth cost of setting up an encrypted link is 3 packets totaling 297 bytes
- Low cost of keeping links open at only 0.44 bits per second - Low cost of keeping links open at only 0.44 bits per second
## Examples of Reticulum Applications ## Examples of Reticulum Applications

4
docs/source/understanding.rst
View File

@ -498,7 +498,7 @@ calculated from the link request packet, into the memory of forwarding nodes,
which means that the communicating nodes can thereafter reach each other simply which means that the communicating nodes can thereafter reach each other simply
by referring to this *link id*. by referring to this *link id*.
The combined bandwidth cost of setting up a link is 3 packets totalling 265 bytes (more info in the The combined bandwidth cost of setting up a link is 3 packets totalling 297 bytes (more info in the
:ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping :ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping
a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
radio channel, 100 concurrent links will still leave 96% channel capacity for actual data. radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.
@ -803,7 +803,7 @@ Wire Format
- Path Request : 51 bytes - Path Request : 51 bytes
- Announce : 157 bytes - Announce : 157 bytes
- Link Request : 83 bytes - Link Request : 83 bytes
- Link Proof : 83 bytes - Link Proof : 115 bytes
- Link RTT packet : 99 bytes - Link RTT packet : 99 bytes
- Link keepalive : 20 bytes - Link keepalive : 20 bytes

2
docs/source/whatis.rst
View File

@ -61,7 +61,7 @@ What does Reticulum Offer?
* Efficient link establishment * Efficient link establishment
* Total bandwidth cost of setting up a link is only 3 packets, totalling 265 bytes * Total bandwidth cost of setting up a link is only 3 packets, totalling 297 bytes
* Low cost of keeping links open at only 0.44 bits per second * Low cost of keeping links open at only 0.44 bits per second