Show link to documentation in the README file

modified: CHANGES.rst modified: README.rst
jugmac00 · Jun 29, 2020 · 0485f44 · 0485f44
1 parent 938bc31
commit 0485f44
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -9,7 +9,8 @@ unreleased
   * update docs/index.rst
   * use blue ReadTheDocs theme
   * update sphinx configuration
-
+  * add documentation link to `setup.py`, so it shows on PyPi
+  * add note about documentation in the README file
 
 
 0.3.1

diff --git a/README.rst b/README.rst
@@ -58,14 +58,22 @@ So, if you use `pip` to install your packages, instead of ...
 This means you do not have to change a single line of code.
 
 
-Contributing
+Installation
 ------------
 
-Contributions are more than welcome. Please have a look at
-https://github.com/jugmac00/flask-reuploaded/issues
+    $ pip install Flask-Reuploaded
 
 
-Installation
+Documentation
+-------------
+
+The documentation can be found at...
+
+https://flask-reuploaded.readthedocs.io/en/latest/
+
+
+Contributing
 ------------
 
-    $ pip install Flask-Reuploaded
+Contributions are more than welcome. Please have a look at
+https://github.com/jugmac00/flask-reuploaded/issues