Merge pull request #25 from Romansth/readme-gif-bug

Readme gif bug

AUTHORS.rst

@@ -10,4 +10,5 @@ Development Lead
 Contributors
 ------------
 
-- wkrt7 (https://github.com/wkrt7)
+- wkrt7 (https://github.com/wkrt7)
+- Roman Shrestha (https://github.com/Romansth)

docs/readme.rst

@@ -1 +1,79 @@
-.. include:: ../README.rst
+======
+asciju
+======
+
+
+.. image:: https://img.shields.io/pypi/v/asciju.svg
+        :target: https://pypi.python.org/pypi/asciju
+
+.. image:: https://img.shields.io/travis/aju100/asciju.svg
+        :target: https://travis-ci.com/aju100/asciju
+
+.. image:: https://readthedocs.org/projects/asciju/badge/?version=latest
+        :target: https://asciju.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+
+
+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
+--------
+
+* Text ASCII art
+* Video conversion on ASCII Art
+* Fix CLI argument parser
+* 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.
+
+Help
+----
+
+.. _pylang2: https://twitter.com/pylang2
+.. _githubissue: https://github.com/Aju100/asciju/issues/new
+
+If you need any help anywhere in the process, you can open `Github issue <githubissue_>`_ or DM a question on `Twitter <pylang2_>`_.
+
+License
+-------
+
+This project is currently licensed under the MIT General Public License v3. i.e. we guarantee end users the freedom to run, study, share, and modify the software.
+
+
+
+Made with ❤️ and Python