From e8aff7adf5410c8e8d3f4172e8e1d8e3b5273094 Mon Sep 17 00:00:00 2001
From: Pedro Ferreira <pedro@dete.st>
Date: Fri, 2 Jun 2017 20:15:26 +0200
Subject: [PATCH] Add README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7e59ad
--- /dev/null
+++ b/README.md
@@ -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.