Skip to content

Commit

Permalink
adding usage docs to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave McLain committed Jul 29, 2011
1 parent e6064c3 commit b3b30e2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.rst
Expand Up @@ -10,7 +10,18 @@ Provides basic commands needed for Armstrong scaffolding
Usage Usage
----- -----


**TODO** armstrong.cli is used as the entry point for all armstrong specific commands as
well as being a replacement for the django manage.py script. The base package
provides the init command which will create a new armstrong project at a
given path.

To create additional armstrong commands, create a callable and specify it as an
'armstrong.command' entry_point via setuptools. If the command can be run
outside of the context of an armstrong project, the callable should have the
attribute ``requires_armstrong`` set to false. Additionally, if the command
takes argument, a subparser from ``argparse`` will be passed to the optional
``build_parser`` method of your command.



Installation Installation
------------ ------------
Expand Down

0 comments on commit b3b30e2

Please sign in to comment.