gergely/pyssb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
Pedro Ferreira 2017-06-02 20:15:26 +02:00
parent fe95688f9d
commit e8aff7adf5
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
** WORK IN PROGRESS **
## pyssb - Secure Scuttlebutt in Python
Please, don't use this for anything that is not experimental. This is a first attempt at implementing the main functionality needed to run an SSB client/server.
Things that are currently implemented:
* Basic Message feed logic
* Secret Handshake
* packet-stream protocol
Usage:
```sh
$ pip install -r requirements.txt
```
Check the `test_*.py` files for basic examples.