Small pass on documentation

README.rst

@@ -4,14 +4,15 @@
 Limpyd
 ======
 
-`Limpyd` provides an **easy** way to store objects in `Redis <http://redis.io/>`_, **without losing the power and the control of the Redis API**, in a *limpid* way, with just as abstraction as needed.
+``Limpyd`` provides an **easy** way to store objects in Redis_, **without losing the power and the control of the Redis API**, in a *limpid* way, with just as abstraction as needed.
 
 Featuring:
 
-- Don't care about keys, `limpyd` do it for you
+- Don't care about keys, ``limpyd`` do it for you
 - Retrieve objects from some of their attributes
 - Retrieve objects collection
 - CRUD abstraction
+- Powerful indexing and filtering
 - Keep the power of all the `Redis data types <http://redis.io/topics/data-types>`_ in your own code
 
 Example of configuration:
@@ -66,8 +67,9 @@ So you can use it like this:
 Install
 =======
 
-Python versions 2.7 and 3.3 to 3.6 are supported.
-Redis-py versions >= 2.9.1, < 2.11 are supported.
+Python versions ``2.7`` and ``3.3`` to ``3.6`` are supported.
+
+Redis-py_ versions ``>= 2.9.1`` and ``< 2.11`` are supported.
 
 .. code:: bash
 
@@ -77,7 +79,7 @@ Redis-py versions >= 2.9.1, < 2.11 are supported.
 Documentation
 =============
 
-See https://redis-limpyd.readthedocs.org/ for a full documentation.
+See https://redis-limpyd.readthedocs.io/ for a full documentation
 
 
 Maintainers
@@ -87,13 +89,15 @@ Maintainers
 * `Yohan Boniface <https://github.com/yohanboniface/>`_
 
 
-Extentions
+Extensions
 ==========
 
-* A bundle of great extensions: `Limpyd-extensions <https://github.com/twidi/redis-limpyd-extensions>`_
-* A queue/task/job manager: `Limpyd-jobs <https://github.com/twidi/redis-limpyd-jobs>`_
+* A bundle of great extensions: `Limpyd-extensions <https://github.com/limpyd/redis-limpyd-extensions>`_
+* A queue/task/job manager: `Limpyd-jobs <https://github.com/limpyd/redis-limpyd-jobs>`_
 
 .. |PyPI Version| image:: https://img.shields.io/pypi/v/redis-limpyd.png
    :target: https://pypi.python.org/pypi/redis-limpyd
-.. |Build Status| image:: https://travis-ci.org/yohanboniface/redis-limpyd.png
-   :target: https://travis-ci.org/yohanboniface/redis-limpyd
+.. |Build Status| image:: https://travis-ci.org/limpyd/redis-limpyd.png
+   :target: https://travis-ci.org/limpyd/redis-limpyd
+.. _Redis: http://redis.io
+.. _Redis-py: https://github.com/andymccurdy/redis-py

doc/README.md

@@ -1 +1,21 @@
-For a better experience you may consult this documentation at https://redis-limpyd.readthedocs.org/
+For a better experience you may consult this documentation at https://redis-limpyd.readthedocs.io/ where it will be automatically updated when a git tag of a stable release will be pushed.
+
+It can be hosted locally, though.
+
+To build it:
+
+- install sphinx and the "read the doc" theme:
+
+```bash
+pip install -r doc/requirements-doc.txt
+```
+
+- build the doc
+
+```bash
+python setup.py build_sphinx
+```
+
+- see it
+
+go to ``file:///local/path/to/redis-limpyd/doc/_build/html/index.html``

doc/about.rst

@@ -2,26 +2,46 @@
 About
 *****
 
-`redis-limpyd` is a project initiated by `Yohan Boniface <https://github.com/yohanboniface/>`_, using python to store "models" in Redis_.
+``redis-limpyd`` is a project initiated by `Yohan Boniface <https://github.com/yohanboniface/>`_, using python to store "models" in Redis_, with the help of `Stéphane «Twidi» Angel <https://github.com/twidi/>`_
 
-The project can be found here: https://github.com/yohanboniface/redis-limyd
 
-Yohan is helped in the developement by `Stéphane "Twidi" Angel <https://github.com/twidi/>`_, with lot of work on his branches, aimed to be integrated upstream via pull requests when we have time to review code.
-You can found these branches here: https://github.com/twidi/redis-limpyd/branches (the `develop` branch is generally up to date with the work on all of them)
+Source
+======
 
-If you want to help, please fork (`master` or a feature branch, not `develop`) and work on a branch with a comprehensive name, write tests (seriously, everything is severely tested in `limpyd`) and make a pull request.
+The project is hosted on Github at https://github.com/limpyd/redis-limpyd
 
 
 Install
 =======
 
-Python version 2.6, 2.7, 3.3 and 3.4 are supported.
-Redis-py versions >= 2.9.1, < 2.11 are supported.
+Python versions ``2.7`` and ``3.3`` to ``3.6`` are supported.
+
+Redis-py_ versions ``>= 2.9.1`` and ``< 2.11`` are supported.
 
 .. code:: bash
 
     pip install redis-limpyd
 
 
+Participation
+=============
+
+If you want to help, please fork (``master`` or a feature branch, not ``develop``) and work on a branch with a comprehensive name, write tests (seriously, everything is severely tested in ``limpyd``) and make a pull request.
+
+
+Maintainers
+===========
+
+* `Stéphane «Twidi» Angel <https://github.com/twidi/>`_ (main maintainer)
+* `Yohan Boniface <https://github.com/yohanboniface/>`_ (creator)
+
+
+Extensions
+==========
+
+* A bundle of great extensions: `Limpyd-extensions <https://github.com/limpyd/redis-limpyd-extensions>`_
+* A queue/task/job manager: `Limpyd-jobs <https://github.com/limpyd/redis-limpyd-jobs>`_
+
 
 .. _Redis: http://redis.io
+.. _Redis-py: https://github.com/andymccurdy/redis-py