From 0e40e95d086ef4f8c0b43d03a5c5da3e7a91d4ef Mon Sep 17 00:00:00 2001 From: Pratyush Desai Date: Sat, 23 Oct 2021 07:02:51 +0530 Subject: [PATCH] update README still WIP --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 52bc627..9b4a25a 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,24 @@ Interactive Login to Liberta Casa Services ========================================== +========================== +Current Scope and Features +========================== + +User Registration + This is the primary feature for the initial release. Liberta Casa exposes many services via SSO which improves + end user experience. The hindrances to this are manual intervention being required for sending users the link + and then telling them to check the email confirmation etc. Also they do need to register it like any old web form. + + One solution to this is the ``KeyCloak`` plugin on the bot but that requires a similar intervention and knowledge of syntax + + This ``Rasa`` based conversational user registration system aims to make this simple for the end user and require less + intervention by network staff. + + +===== +Setup +===== + +* Set up a virtual environment using ``python3 -m venv venv`` +* Clone the repository and install the dependencies using ``pip3 install -r requirements.txt``