Skip to content

Commit

Permalink
Added Usage section to README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Medhat Gayed committed Jan 23, 2018
1 parent 29a30c3 commit 7c03faa
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,26 @@ Add it to your `INSTALLED_APPS`:
...
)
Add Django RQ Pulse's URL patterns:
Usage
--------

.. code-block:: python
from django_rq_pulse import urls as django_rq_pulse_urls
urlpatterns = [
...
url(r'^', include(django_rq_pulse_urls)),
...
]
# Check that rqworkers are running.
python manage.py rq_pulse_check
Features
--------
# The above command will run with default parameters where
# --expected-num-workers=2
# --seconds-to-sleep=5
# --num-retries=5
# --queue-name="default"
* TODO
# You can override these values by passing any or all the parameters to the command like so:
python manage.py rq_pulse_check --expected-num-workers=3 --queue-name="high"
# To get a list of the command parameters use the --help parameter.
python manage.py rq_pulse_check --help
Running Tests
-------------

Expand Down

0 comments on commit 7c03faa

Please sign in to comment.