summaryrefslogtreecommitdiff
path: root/keymanager/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'keymanager/README.rst')
-rw-r--r--keymanager/README.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/keymanager/README.rst b/keymanager/README.rst
new file mode 100644
index 0000000..1d4b53e
--- /dev/null
+++ b/keymanager/README.rst
@@ -0,0 +1,29 @@
+LEAP's Key Manager
+==================
+.. image:: https://badge.fury.io/py/leap.keymanager.svg
+ :target: http://badge.fury.io/py/leap.keymanager
+.. image:: https://img.shields.io/pypi/dm/leap.keymanager.svg
+ :target: http://badge.fury.io/py/leap.keymanager
+
+The Key Manager is a `Nicknym`_ agent for the `LEAP`_ project, written in python using the `twisted`_ async framework.
+
+.. _`Nicknym`: https://leap.se/nicknym
+.. _`LEAP`: https://leap.se/docs/
+.. _`twisted`: https://twistedmatrix.com/trac/
+
+
+running tests
+-------------
+
+Use trial to run the test suite::
+
+ trial leap.keymanager
+
+License
+=======
+
+.. image:: https://raw.github.com/leapcode/bitmask_client/develop/docs/user/gpl.png
+
+leap.keymanager is released under the terms of the `GNU GPL version 3`_ or later.
+
+.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt