Updated README.md

Author: OmkarPathak

docs/conf.py

@@ -4,6 +4,11 @@
 import sys
 import os
 import shlex
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -29,8 +34,8 @@
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
-source_suffix = '.md'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

docs/index.rst

@@ -0,0 +1,27 @@
+============================
+Pygorithm
+============================
+
+A fun way to learn algorithms on the Go!
+
+Just import the module and start learning, it's that easy.
+
+-----------------
+Quick Start Guide
+-----------------
+
+::
+
+    from pygorithm.sorting import bubble_sort
+
+    # This will print the code for bubble sort
+    print(bubble_sort.get_code())
+
+    myList = [12, 4, 2, 14, 3, 7, 5]
+
+    # to sort the list
+    sorted_list = bubble_sort.sort(myList)
+
+---------------
+Getting Started
+---------------