Add README.md and Getting_Started.md

3 files changed, 61 insertions, 1 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b75d30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# **Workshop Booking**
+
+> This website is for coordinators to book a workshop(s), they can book a workshop based on instructors posts or can propose a workshop date based on their convenience.
+
+
+### Features
+* Statistics
+    1. Instructors Only
+        * Monthly Workshop Count
+        * Instructor/Coordinator Profile stats
+        * Upcoming Workshops
+    2. Open to All
+        * Workshops taken over Map of India
+        * Pie chart based on Total Workshops taken to Type of Workshops.
+
+* Workshop Related Features
+    > Instructors can Accept, Reject or Delete workshops based on their preference, also they can postpone a workshop based on coordinators request.
+
+__NOTE__: Check docs/Check Getting_Started.md for more info.
\ No newline at end of file
diff --git a/docs/Getting_Started.md b/docs/Getting_Started.md
new file mode 100644
index 0000000..7a81154
--- /dev/null
+++ b/docs/Getting_Started.md
@@ -0,0 +1,40 @@
+# Guide to install and get this website running
+
+### Follow below given Steps to get started
+> __NOTE__: Use Python3 
+1. Clone this repo.
+    > git clone https://github.com/FOSSEE/workshop_booking.git
+
+2. Create a virtual environment and install all the required packages from requirements.txt
+    > pip install -r requirements.txt 
+
+3. Make Migrations and Migrate
+    > python manage.py makemigrations\
+    > python manage.py migrate
+
+4. Create Super User
+    > python manage.py createsuperuser
+
+5. Start Server
+    > python manage.py runserver
+
+6. Goto admin page and login using superuser credentials
+    > localhost:8000/admin
+
+7. Goto Groups and create one group called __instructor__ and give it all permissions.
+
+8. By default when a user registers, he is assigned a coordinator position, using the admin panel set the required users profile position as instructor and add him/her in instructor group along with the required permissions.
+
+9. Under *settings.py* file see to it that all required variables are set then you're good to go!
+
+### Instrutor specific steps
+
+1. An instructor can create workshops as per his/her availibility in __Create Workshop__ tab.
+
+2. Instructor can see monthly workshop count, upcoming workshop etc. in Statistics > Workshop Statistics
+
+
+### Coordinator specific steps
+
+1. A coordinator can sent workshop proposal based on his/her convenience under Workshops > Propose a Workshop option.
+
diff --git a/workshop_portal/settings.py b/workshop_portal/settings.py
index 57cf8ad..cf3db96 100644
--- a/workshop_portal/settings.py
+++ b/workshop_portal/settings.py
@@ -158,7 +158,8 @@ PRODUCTION_URL = 'your_production_url'
 
 ADMIN_EMAIL = 'your admin email'
 
-SHOW_WORKSHOP_STATS = False #Set True or False to view/hide
+#Set True or False to view/hide
+SHOW_WORKSHOP_STATS = False 
 
 LOGIN_REDIRECT_URL = '/profile'
 SESSION_EXPIRE_AT_BROWSER_CLOSE = True