diff --git a/README.md b/README.md index df445313..df271fb3 100644 --- a/README.md +++ b/README.md @@ -67,21 +67,36 @@ When set to `false`, a login will be required for connecting users. Go ahead and run `shout --help`: ``` -Usage: shout [options] [command] +$ shout --help -Commands: + Usage: shout [options] [command] - list - List all existing users - - add - Add a new user - - remove - Remove an existing user + Commands: - edit - Edit an existing user + start + Start the server + + config + Edit config: '/usr/lib/node_modules/shout/config.json' + + list + List all existing users + + add + Add a new user + + remove + Remove an existing user + + edit + Edit user: '/home/erming/.shout/users//user.json' + + + Options: + + -h, --help output usage information + -h, --host host + -p, --port port ``` Pretty simple, huh?