Add CLI usage example in README

This commit is contained in:
Gavin M. Roy 2014-08-22 14:57:20 -04:00
parent 3b351f5658
commit 09058e1e73

View file

@ -3,3 +3,22 @@ Sprockets
A loosely coupled framework built on top of Tornado. Take what you need to build
awesome applications.
CLI Usage
---------
```usage: sprockets [-h] [-l] [-d] [-s] [-v] [--version]
{http,amqp} ... application
positional arguments:
{http,amqp} Available sprockets application controllers
http HTTP Application Controller
amqp RabbitMQ Worker Controller
application The sprockets app to run
optional arguments:
-h, --help show this help message and exit
-l, --list List installed sprockets apps
-d, --daemonize Fork into a background process
-s, --syslog Log to syslog
-v, --verbose Verbose logging output
--version show program's version number and exit
```