From 5f93577515ed1d85986c55d2864dd964a6cd1d4e Mon Sep 17 00:00:00 2001 From: Jordan Doyle Date: Thu, 17 Jan 2019 00:12:05 +0000 Subject: [PATCH] Create README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6879185 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# sonos-cli + +Control and monitor your Sonos speakers from the command line. + +## Build from source + +```bash +$ git clone git@github.com:w4/sonos-cli.git && cd sonos-cli +$ cargo build --release +$ mv target/release/sonos-cli /usr/local/bin/sonos +``` + +## Usage + +``` +sonos 0.1.0 +Jordan Doyle +Control your Sonos using the command line + +USAGE: + sonos-cli [OPTIONS] [json] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -c Set the controller to run operation on + +ARGS: + Return back JSON serialised responses for programmatic use of the CLI + +SUBCOMMANDS: + help Prints this message or the help of the given subcommand(s) + info Shows information about the speaker + next Skip to the next track + previous Go back to the last track + rooms List all of your speakers + seek Seek to a specific timestamp on the current track + track Show the current track information + volume Get or set the volume of the speaker +``` -- libgit2 1.7.2