Merge pull request #17 from Aju100/docs-improve

Docs improve
Aju100 · Mar 31, 2021 · a7abecd · a7abecd
2 parents 253271a + 67465b6
commit a7abecd
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -21,14 +21,31 @@ Python package that converts image to ascii
 
 * Free software: MIT license
 * Documentation: https://asciju.readthedocs.io.
-
+* Python Package Index: https://pypi.org/project/asciju/
 
 
 Features
 --------
 
 * Conversion image to ASCII art
 
+
+Usage
+-----
+
+Convert your image into ASCII art::
+
+        from asciju import convert_img_ascii
+
+        print(convert_img_ascii('yourimage.jpeg','output.txt'))
+
+Run the python script::
+
+        python3 nameofthescript.py
+
+
+.. image:: assets/run.gif
+
 Roadmap
 --------
 
@@ -38,3 +55,11 @@ Roadmap
 * Improved Documentation
 * Unit Test
 
+Contribute
+------------
+.. _contribute: https://github.com/Aju100/asciju/blob/main/CONTRIBUTING.rst
+
+Contributions are always welcome! Please read the `contribution guidelines <contribute_>`_ first.
+
+
+Made with ❤️ and Python
diff --git a/assets/run.gif b/assets/run.gif
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -7,7 +7,7 @@ To use asciju in a project::
     import asciju
 
 Convert your image into ASCII art::
-
+ 
     from asciju import convert_img_ascii
 
     print(convert_img_ascii('yourimage.jpeg','output.txt'))
@@ -62,6 +62,3 @@ Output::
     BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSBBS&#SBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
     BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
     BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
-
-
-