summaryrefslogtreecommitdiff
path: root/bonafide/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'bonafide/README.rst')
-rw-r--r--bonafide/README.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/bonafide/README.rst b/bonafide/README.rst
index af56016..ffcf2ff 100644
--- a/bonafide/README.rst
+++ b/bonafide/README.rst
@@ -1,15 +1,20 @@
Bonafide
========
-Secure user registration, authentication, and provider discovery for the LEAP
-applications.
+Bonafide is the protocol for secure user registration, authentication, and provider discovery for the LEAP
+applications. See the `Bonafide`_ design docs.
-https://leap.se/en/docs/design/bonafide
+This is a client implementation, written in python.
+
+.. _`Bonafide`: https://leap.se/en/docs/design/bonafide
Using
-----
-This is still in development. To play with it, create a virtualenv, and run::
- python setup.py development
+
+This is still in development. To play with it, create a virtualenv, and deploy
+the package in development mode by running::
+
+ python setup.py develop
from the parent folder.
-Then you can use `bonafide_cli`.
+Then you can use `bonafide_cli -h` to see the available commands.