Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

adding usage docs to the README

  • Loading branch information...
commit b3b30e2f77ae65712f9b7feddc8f866c7421a025 1 parent e6064c3
Dave McLain authored
Showing with 12 additions and 1 deletion.
  1. +12 −1 README.rst
View
13 README.rst
@@ -10,7 +10,18 @@ Provides basic commands needed for Armstrong scaffolding
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
------------
Please sign in to comment.
Something went wrong with that request. Please try again.