Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hunterboerner committed Apr 25, 2015
1 parent cdbd9e3 commit cc5e6d1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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?\""`.

0 comments on commit cc5e6d1

Please # to comment.