Readme file updated

Saikat248 · Dec 18, 2021 · 78f15a4 · 78f15a4
1 parent 7cd92e8
commit 78f15a4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,9 @@
+anooplab-docs
+=============
+
+.. image:: https://readthedocs.org/projects/xtb-docs/badge/?version=latest
+   :alt: Documentation Status
+   :target: https://xtb-docs.readthedocs.io
+
+Currently this website is hosted `here <https://anooplab-docs.readthedocs.io/en/latest/>`_
+
diff --git a/docs/how_to_contribute.rst b/docs/how_to_contribute.rst
@@ -12,6 +12,7 @@ Installation
 ------------
 
 Clone the github repo
+
 .. code:: console
 
 	$ git clone https://github.com/Saikat248/anooplab-docs.git
@@ -39,6 +40,6 @@ It will create a ``_build`` directory and the ``html`` files
 	$ firefox _build/html/index.html
 
 The whole website will run locally.
-Go ahead start editing the documents and before pushing make sure if the build is successful.
+Go ahead start editing the documents and before pushing make sure the build is successful.
 
 Enjoy !!
diff --git a/docs/index.rst b/docs/index.rst
@@ -76,9 +76,10 @@ External Libraries/Packages
    :maxdepth: 3
    :caption: Misc
 
+   how_to_contribute
    license
    credits
-   how_to_contribute
+
 
 ..
   * :ref:`genindex`