From 46428087b4d1ce9228bec052eca1bea319bd6299 Mon Sep 17 00:00:00 2001
From: Sha <mohansha@github.com>
Date: Mon, 12 Feb 2018 14:56:02 +0530
Subject: [PATCH] Updated Readme

---
 README.md | 234 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 233 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96dae02..b392c2c 100755
--- a/README.md
+++ b/README.md
@@ -1 +1,233 @@
-# py-Chatbot
+# Chatbot
+Python chatbot AI that helps in creating a python based chatbot with
+minimal coding. This provides both bots AI and chat handler and also
+allows easy integration of REST API's and python function calls which
+makes it unique and more powerful in functionality. This AI provides
+numerous features like learn, memory, conditional switch, topic-based
+conversation handling, etc.
+
+## Installation
+
+Install from PyPI:
+```sh
+pip install chatbotAI
+```
+
+install from github:
+```sh
+git clone https://github.com/MohanSha/py-Chatbot.git
+cd Chatbot
+python setup.py install
+```
+
+## Demo
+```python
+>>> from chatbot import demo
+>>> demo()
+Hi, how are you?
+> i'm fine
+Nice to know that you are fine  
+> quit
+Thank you for talking with me.
+>>> 
+```
+
+## Sample Code (with wikipedia search API integration)
+
+```python
+from chatbot import Chat,reflections,multiFunctionCall
+import wikipedia
+
+def whoIs(query,sessionID="general"):
+    try:
+        return wikipedia.summary(query)
+    except:
+        for newquery in wikipedia.search(query):
+            try:
+                return wikipedia.summary(newquery)
+            except:
+                pass
+    return "I don't know about "+query
+        
+call = multiFunctionCall({"whoIs":whoIs})
+firstQuestion="Hi, how are you?"
+Chat("examples/Example.template", reflections,call=call).converse(firstQuestion)
+```
+
+## List of feature supported in bot template
+1. [Memory](#memory)
+2. [Get matched group](#get-matched-group)
+3. [Recursion](#recursion)
+4. [Condition](#condition)
+5. [Change Topic](#change-topic)
+6. [Interact with python function](#interact-with-python-function)
+7. [REST API integration](#rest-api-integration)
+8. [Topic based group](#topic-based-group)
+9. [Learn](#learn)
+10. [To upper case](#to-upper-case)
+11. [To lower case](#to-lower-case)
+12. [Capitalize](#capitalize)
+13. [Previous](#previous)
+
+---
+
+## Memory
+
+#### Set Memory
+```
+{ variable : value }
+```
+In think mode
+```
+{! variable : value }
+```
+
+#### Get Memory
+```
+{ variable }
+```
+
+## Get matched group
+#### Get N<sup>th</sup> matched group of client pattern
+```
+%N
+```
+Example to get first matched
+```
+%1
+```
+
+#### Get N<sup>th</sup> matched group of bots pattern
+```
+%!N
+```
+Example to get first matched
+```
+%!1
+```
+
+## Recursion
+Get response as if client said this new statement
+```
+{% chat statement %}
+```
+It will do a pattern match for statement
+
+## Condition
+``` 
+{% if condition %} do this first {% elif condition %} do this next {% else %} do otherwise {% endif %}
+```
+
+## Change Topic
+```
+{% topic TopicName %}
+```
+
+## Interact with python function
+```
+{% call functionName: value %}
+```
+
+## REST API integration
+ 
+### In API.json file
+ ```
+{
+    "APIName":{
+        "auth" : {
+            "url":"https://your_rest_api_url/login.json",
+            "method":"POST",
+            "data":{
+                "user":"Your_Username",
+                "password":"Your_Password"
+            }
+        },
+        "MethodName" : {
+            "url":"https://your_rest_api_url/GET_method_Example.json",
+            "method":"GET",
+            "params":{
+                "key1":"value1",
+                "key2":"value2",
+                ...
+            },
+            "value_getter":[order in which data has to be picked from json response]
+        },
+        "MethodName1" : {
+            "url":"https://your_rest_api_url/GET_method_Example.json",
+            "method":"POST",
+            "data":{
+                "key1":"value1",
+                "key2":"value2",
+                ...
+            },
+            "value_getter":[order in which data has to be picked from json response]
+        },
+        "MethodName2" : {
+            ...
+        },
+        ...
+    },
+    "APIName2":{
+        ...
+    },
+    ...
+}
+```
+*If authentication is required only then `auth` method is needed.The `data` and `params` defined in pi.json file acts as defult values and all key value pair defined in template file overrides the default value.`value_getter` consistes of list of keys in order using which info from json will be collected.*
+
+### In Template file
+```
+[ APIName:MethodName,Key1:value1 (,Key*:value*) ]
+```
+you can have any number of key value pair and all key value pair will override data or params depending on `method`, if `method` is `POST` then it overrides data and if method is `GET` then it overrides `params`.
+
+## Topic based group 
+```
+{% group topicName %}
+  {% block %}
+      {% client %}client says {% endclient %}
+      {% response %}response text{% endresponse %}
+  {% endblock %}
+  ...
+{% endgroup %}
+```
+
+## Learn
+```
+{% learn %}
+  {% group topicName %}
+    {% block %}
+        {% client %}client says {% endclient %}
+        {% response %}response text{% endresponse %}
+    {% endblock %}
+    ...
+  {% endgroup %}
+  ...
+{% endlearn %}
+```
+
+## To upper case
+```
+{% up string %}
+```
+
+## To lower case
+```
+{% low string %}
+```
+
+## Capitalize
+```
+{% cap string %}
+```
+
+## Previous
+```
+{% block %}
+    {% client %}client's statement pattern{% endclient %}
+    {% prev %}previous bot's statement pattern{% endprev %}
+    {% response %}response string{% endresponse %}
+{% endblock %}
+```
+
+