@minor adding install docs.

toumorokoshi · Dec 29, 2016 · ba4f4b1 · ba4f4b1
1 parent 66eaded
commit ba4f4b1
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -58,6 +58,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   install
    routes
    serialization
    documentation
diff --git a/docs/install.rst b/docs/install.rst
@@ -0,0 +1,16 @@
+==========
+Installing
+==========
+
+aiohttp-transmute can be installed via `Pip <https://pip.pypa.io/en/stable/>`_, from `PyPI <https://pypi.python.org/>`_:
+
+.. code-block:: bash
+
+    $ pip install aiohttp-transmute
+
+
+Pip allows installation from source as well:
+
+.. code-block:: bash
+
+    $ pip install git+https://github.com/toumorokoshi/aiohttp-transmute.git#egg=aiohttp-transmute
diff --git a/docs/routes.rst b/docs/routes.rst
@@ -23,6 +23,9 @@ a decorator converting a function to an aiohttp route:
     # append to your route later
     aiohttp_transmute.route(app, multiply)
 
+the aiohttp request argument is supported: it will be passed into
+any function that has 'request' in it's function signature.
+
 see `transmute-core:function <http://transmute-core.readthedocs.io/en/latest/function.html#functions>`_ for more information on customizing
 transmute routes.