Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lorenzo Berni committed Feb 16, 2017
1 parent 9c33e4d commit ff12021
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Revived
=======

.. image:: https://readthedocs.org/projects/revived/badge/?version=latest
:target: http://revived.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

---------------------------------------------------------------------
A predictable state container for python *heavily* inspired by Redux_
---------------------------------------------------------------------
Expand All @@ -14,10 +18,17 @@ do pretty much the same job in the most pythonic way possible.

Contents
--------
* Documentation_
* Installation_
* Examples_
* Contribute_
* Documentation_

Documentation
-------------

Currently the documentation is not buliding into ReadTheDocs (see
`issue #11 <https://github.com/RookieGameDevs/revived/issues/11>`_). You can
build the documentation locally. Check out Contribute_ section.

Installation
------------
Expand Down Expand Up @@ -71,11 +82,6 @@ Contribute
#. Create a pull request.
#. Profit :)

Documentation
-------------

More detailed documentation is **coming soon**.

.. _Redux: http://redux.js.org/
.. _`Redux API`: Redux_
.. _virtualenv: https://virtualenv.pypa.io/en/stable/
Expand Down

0 comments on commit ff12021

Please sign in to comment.