From a3d5c5d699347d4fa26e82e13d34b6d9f9b14beb Mon Sep 17 00:00:00 2001 From: Paul Friederichsen Date: Wed, 5 Aug 2015 21:23:07 -0500 Subject: [PATCH] Created Usage (markdown) --- Usage.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 Usage.md diff --git a/Usage.md b/Usage.md new file mode 100644 index 0000000..187c63d --- /dev/null +++ b/Usage.md @@ -0,0 +1,117 @@ +Once you've installed Shou, go ahead and run: + +``` +$ shout --help +``` + +This will give you an overiew of the commands you can use. + +## `start` + +_Start the Shou server._ + +Example: + +``` +$ shout start --port 80 --private +``` + +Options: + +- `-p, --port` +- `-h, --host` +- `--public` +- `--private` + +## `config` + +_Open the configuration file._ + +Example: + +``` +$ shout config +``` + +## `list` + +_List all existing users._ + +Example: + +``` +$ shout list +``` + +## `add []` + +_Add a new user._ + +Example: + +``` +$ shout add john +``` + +## `remove ` + +_Remove an existing user._ + +Example: + +``` +$ shout remove john +``` + +## `reset ` + +_Reset user password._ + +Example: + +``` +$ shout reset john +``` + +## `edit ` + +_Edit user configuration file._ + +Example: + +``` +$ shout edit john +``` + +# Options + +## `--home` + +_Set the home path. This is the location where Shou will look for the `config.js` and the `users/` folder._ + +Example: + +``` +$ shout --home /app add # add user to /app/users +$ shout --home /app # start server with /app/config.js +``` + +## `--help` + +_Output usage information._ + +Example: + +``` +$ shout --help +``` + +## `--version` + +_Output the version number._ + +Example: + +``` +$ shout --version +``` \ No newline at end of file