diff --git a/README.md b/README.md index 43c609f..045bd64 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # output-formatter Annotate/prefix command output. + +![Picture](screenshot.png) + +# Install + +`go get -u github.com/rabbit-ci/output-formatter` + +# Usage + +``` +output-formatter your command +``` + +Disclaimer: arguments passed to output-formatter will be joined into a string and sent to "bash -c". This allows for things like `"echo 'bleh' >&2"` to be run and show up as stderr. This means that `output-formatter echo "Isn't it cool?"` will fail because the `"`'s are removed and it's actually running: `bash -c echo Isn't it cool?`. Fix this by quoting the whole command: `output-formatter "echo \"Isn't it cool?\""`.