From b1dfdbd3f52027b2b2c2755adb7b12973b376ff5 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 27 Oct 2015 10:00:45 -0400 Subject: add link to readme --- README.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index af56016..ffcf2ff 100644 --- a/README.rst +++ b/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. -- cgit v1.2.3