Add installation instructions to the README and the docs (#113)

* Added installation instruction to README and Installation section to the docs * Added installation instruction to README and Installation section to the docs * Update installation.rst --------- Co-authored-by: Vincent Michel <vxgmichel@gmail.com>
vxgmichel · Jun 17, 2024 · b405eda · b405eda
1 parent 8220c00
commit b405eda
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -100,6 +100,10 @@ The following example demonstrates most of the streams capabilities:
 
 More examples are available in the `example section`_ of the documentation.
 
+Installation
+-------
+
+You can install aiostream from PyPI as the `aiostream package`_.
 
 Contact
 -------
@@ -166,6 +170,8 @@ Vincent Michel: vxgmichel@gmail.com
 .. _action: http://aiostream.readthedocs.io/en/latest/operators.html#aiostream.stream.action
 .. _print: http://aiostream.readthedocs.io/en/latest/operators.html#aiostream.stream.print
 
+.. _aiostream package: https://pypi.org/project/aiostream/
+
 .. |docs-badge| image:: https://readthedocs.org/projects/aiostream/badge/?version=latest
    :target: http://aiostream.readthedocs.io/en/latest/?badge=latest
    :alt:

diff --git a/docs/index.rst b/docs/index.rst
@@ -27,6 +27,7 @@ Generator-based operators for asynchronous iteration
 .. toctree::
    :maxdepth: 1
 
+   installation
    presentation
    operators
    core

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,12 @@
+Installation
+============
+
+aiostream_ is available on PyPi_ - to install it run:
+
+.. code-block:: sh
+
+    python -m pip install -U 'aiostream'
+
+
+.. _aiostream: https://github.com/vxgmichel/aiostream
+.. _PyPi: https://pypi.org/project/aiostream/