From 4f028d74b5e8509d9a4140c783c969fe87857041 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 4 Apr 2018 14:32:29 +0200 Subject: [PATCH] Updated readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ccc696e..e8e6fa7 100755 --- a/README.md +++ b/README.md @@ -10,6 +10,16 @@ For more info, see [unsigned.io/projects/reticulum](http://unsigned.io/projects/ ## Current Status Reticulum is currently in pre-alpha state. Even the master branch should be considered experimental. At this point the protocol may change without notice, and is made publicly available for development collaboration, previewing and testing features. Do not build anything serious with Reticulum yet. Stable alpha release will be at the end of May 2018. +## What hardware does Reticulum work with? +Practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, HAM radio digital modes, free-space optical systems and others are all examples of the types of interfaces Reticulum was designed for. + +An open-source LoRa-based interface has been designed specifically for use with Reticulum and will be available along with the stable alpha release. It is easy to build yourself, or can be purchased as a complete radio that just needs a USB connection to the host. + +Reticulum can also be tunneled over existing IP networks. + +## How do I get started? +Full documentation and video tutorials are coming with the stable alpha release. Until then, you are on your own. If you really want to experiment already, you could take a look in the "Utilities" folder, for some well-documented example programs. Be sure to also read the [Reticulum Overview Document](http://unsigned.io/wp-content/uploads/2018/04/Reticulum_Overview_v0.4.pdf) + ## Dependencies: - cryptography.io - pyserial 3.1