Updated README for v0.2.0

This commit is contained in:
Ilan Steemers
2015-07-04 11:46:19 +02:00
parent 7008784b76
commit 75015596a6
+5 -4
View File
@@ -41,7 +41,7 @@ Installation
$ pip install django-q $ pip install django-q
- Add :mod:`django_q` to your :const:`INSTALLED_APPS` in your projects :file:`settings.py`:: - Add `django_q` to your `INSTALLED_APPS` in your projects `settings.py`::
INSTALLED_APPS = ( INSTALLED_APPS = (
# other apps # other apps
@@ -80,6 +80,8 @@ All configuration settings are optional. e.g:
'db': 0, } 'db': 0, }
} }
For full configuration options, see the `documentation <http://django-q.readthedocs.org>`__.
Management Commands Management Commands
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@@ -94,7 +96,7 @@ Monitor your clusters with::
Creating Tasks Creating Tasks
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Use async from your code to quickly offload tasks: Use `async` from your code to quickly offload tasks:
.. code:: python .. code:: python
@@ -120,7 +122,6 @@ Use async from your code to quickly offload tasks:
def print_result(task): def print_result(task):
print(task.result) print(task.result)
.. code:: python
Schedule Schedule
^^^^^^^^ ^^^^^^^^
@@ -157,7 +158,7 @@ To run the tests you will need `py.test <http://pytest.org/latest/>`__ and `pyte
Todo Todo
~~~~ ~~~~
- Write sphinx documentation - Write more sphinx `documentation <https://django-q.readthedocs.org>`__
- Better tests and coverage - Better tests and coverage
- Get out of Alpha - Get out of Alpha
- Less dependencies? - Less dependencies?