Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GaretJax committed Sep 14, 2015
1 parent e0236ba commit 2eded5d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
History
=======

1.0.0 – Unreleased
1.0.0 – 2015-09-14
==================

* Support for command groups
Expand Down
12 changes: 11 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Example
=======

Create a command module as you would usually do, but instead of creating a
class, just put a djclick command into it:
class, just put a ``djclick`` command into
``<yourapp>/management/commands/helloworld.py``:

.. code:: python
Expand All @@ -60,3 +61,12 @@ class, just put a djclick command into it:
@click.argument('name')
def command(name):
click.secho('Hello, {}'.format(name), fg='red')
And then call the command with::

$ ./manage.py helloworld django-click
Hello, django-click

Check out the `test commands
<https://github.com/GaretJax/django-click/tree/master/djclick/test/testprj/testapp/management/commands>`_
for additional example commands and advanced usage.

0 comments on commit 2eded5d

Please sign in to comment.