From 09058e1e730d3667da7364cd2c7bbc8c749bd592 Mon Sep 17 00:00:00 2001 From: "Gavin M. Roy" Date: Fri, 22 Aug 2014 14:57:20 -0400 Subject: [PATCH] Add CLI usage example in README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e56be88..56871a4 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file