Updated documentation

README.rst

@@ -1,6 +1,6 @@
-===============================
-amanita
-===============================
+=======
+Amanita
+=======
 
 .. image:: https://img.shields.io/pypi/v/amanita.svg
     :target: https://pypi.python.org/pypi/amanita
@@ -14,13 +14,11 @@ amanita
    :target: https://amanita.readthedocs.io
    :alt: Latest Readthedocs build status
 
-Create python customizable projects.
+Create customizable python projects from a simple package
+directory layout to a web application.
 
 Documentation on `read the docs <https://amanita.readthedocs.io>`_.
 
-Usage
-=====
-
 Ingredients
 ===========
 
@@ -36,9 +34,25 @@ Ingredients
      :target: https://www.debian.org
      :alt: Debian
 
-  .. image:: resources/img/cookiecutter.png
-     :target: https://github.com/audreyr/cookiecutter
-     :alt: Cookiecutter
+  .. image:: resources/img/git.png
+     :target: https://git-scm.com
+     :alt: Git
+
+  .. image:: resources/img/direnv.png
+     :target: https://direnv.net
+     :alt: Direnv
+
+  .. image:: resources/img/poetry.png
+     :target: https://poetry.eustace.io
+     :alt: PyPoetry
+
+  .. image:: resources/img/click.png
+     :target: https://click.palletsprojects.com/en/7.x
+     :alt: Click
+
+  .. image:: resources/img/sphinx.png
+     :target: http://www.sphinx-doc.org/en/stable
+     :alt: Sphinx
 
   .. image:: resources/img/amanita.png
      :target: https://es.wikipedia.org/wiki/Amanita_muscaria
@@ -49,20 +63,81 @@ Installation
 
 .. code-block:: sh
 
-   pip install amanita
+  pip install amanita
 
-------------
 Requirements
 ------------
 
+All requirements are installed (with the user approval) when needed:
+
+  - `pypoetry <https://poetry.eustace.io>`_.
+  - `direnv <https://direnv.net>`_: optional, Linux or MacOS only.
+  - `git <https://git-scm.com>`_: optional.
+
+Usage
+=====
+
+To create a simple package directory:
+
+.. code-block:: sh
+
+  amanita my_project
+
+To create a package with a virtual enviroment:
+
+.. code-block:: sh
+
+  amanita my_project -v
+
+To create a package with development profile:
+
+.. code-block:: sh
+
+  amanita my_project --dev
+
+A development profile includes:
+
+  - A virtual enviroment.
+  - `Direnv <https://direnv.net>`_ configuration.
+  - `Sphinx <http://www.sphinx-doc.org/en/stable>`_ configuration.
+  - A `git <https://git-scm.com/>`_ repository.
+
+To create a web application with `flask <https://flask.pocoo.org>`_ from an `openapi <https://swagger.io/specification>`_ specification:
+
+.. code-block:: sh
+
+  amanita my_project -a /home/user/api.yml
+
+Options
+=======
+
+This package offers multiple options to customize the project creation
+process:
+
+  -V, --version         Show the version and exit.
+  -d, --direnv          Install and configure  `direnv <https://direnv.net>`_ console enviroment
+                        switcher.
+  -v, --venv            Create and configure a virtual enviroment inside the
+                        project.
+  -e, --venv-path TEXT  Create and configure a virtual enviroment on the given
+                        path.
+  -h, --help            Show help and exit.
+
 Compatibility
 =============
 
+Python 3.
+
 License
 =======
 
 MIT. See the `LICENSE <LICENSE>`_ file for more details.
 
+API
+===
+
+See `read the docs <https://amanita.readthedocs.io>`_.
+
 Authors
 =======
 
@@ -71,5 +146,5 @@ Authors
 Enjoy!!
 
   .. image:: resources/img/enjoy.png
-     :alt: Amanita
+     :alt: Enjoy!!
 

docs/source/index.rst

@@ -1,12 +1,14 @@
 .. amanita documentation master file, created by
-   sphinx-quickstart on Fri Nov  2 22:28:21 
+   sphinx-quickstart on Fri Nov  2 22:28:21
 
 Amanita
 =======
 
 Create customizable python projects from a simple package
 directory layout to a web application.
 
+This program has ben written and tested on `Debian <https://debian.org>`_.
+
 Ingredients
 ===========
 
@@ -29,7 +31,7 @@ Ingredients
   .. image:: ../../resources/img/direnv.png
      :target: https://direnv.net
      :alt: Direnv
-	   
+
   .. image:: ../../resources/img/poetry.png
      :target: https://poetry.eustace.io
      :alt: PyPoetry
@@ -53,13 +55,22 @@ Installation
 
   pip install amanita
 
+Requirements
+------------
+
+All requirements are installed (with the user approval) when needed:
+
+  - `pypoetry <https://poetry.eustace.io>`_.
+  - `direnv <https://direnv.net>`_: optional, Linux or MacOS only.
+  - `git <https://git-scm.com>`_: optional.
+
 Usage
 =====
 
 To create a simple package directory:
 
 .. code-block:: sh
-		
+
   amanita my_project
 
 To create a package with a virtual enviroment:
@@ -74,7 +85,7 @@ To create a package with development profile:
 
   amanita my_project --dev
 
-The development profile includes:
+A development profile includes:
 
   - A virtual enviroment.
   - `Direnv <https://direnv.net>`_ configuration.
@@ -102,9 +113,28 @@ process:
                         path.
   -h, --help            Show help and exit.
 
+Compatibility
+=============
+
+Python 3.
+
+License
+=======
+
+MIT. See the `LICENSE <LICENSE>`_ file for more details.
+
 API
 ===
 
 * :ref:`modindex`
 * :ref:`genindex`
 
+Authors
+=======
+
+`amanita` was written by `constrict0r <constrict0r@protonmail.com>`_.
+
+Enjoy!!
+
+  .. image:: ../../resources/img/enjoy.png
+     :alt: Enjoy!!