From 3270cedb44c4cd44261defe7141658819970317d Mon Sep 17 00:00:00 2001 From: John Dyer Date: Fri, 6 Mar 2015 09:15:43 -0500 Subject: [PATCH] Update readme and add changelog --- README.md | 25 ++++++++++++++++++------- changelog.md | 5 +++++ 2 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 changelog.md diff --git a/README.md b/README.md index 21003ae..16b886c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # anybar-go -Go CLI for Anybar ( https://github.com/tonsky/AnyBar ) + +Small go app to send commands to [Anybar](https://github.com/tonsky/AnyBar). ## Building -./make.sh +* Build artifact `./make.sh` +* Copy to bin `cp builds/anybar-go.osx ~/bin/anybar-go` +* Profit + ## Development go get github.com/tools/godep @@ -19,7 +23,7 @@ NAME: anybar-go - Anybar CLI USAGE: - anybar-go [global options] command [command options] + anybar-go [global options] command [command options] [arguments...] VERSION: 0.0.1 @@ -33,14 +37,21 @@ COMMANDS: GLOBAL OPTIONS: --port, -p '1738' Port to connect to anybar [$ANYBAR_PORT] --address, -a 'localhost' Address to send message. - --msg, -m Message to send to anybar --help, -h show help - --version, -v + --version, -v print the version + ``` ### Sending message -#### Default +#### Defaults + + ./anybar-go.osx green + +#### Setting port + + ./anybar-go.osx green -p 2000 + + - ./anybar-go.osx --msg green diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..182e97b --- /dev/null +++ b/changelog.md @@ -0,0 +1,5 @@ +# Changelog + +##0.0.1 + +* Initial release