From cc5e6d183150350447278d15f958c23edc2d3bf9 Mon Sep 17 00:00:00 2001
From: Theron Boerner <hunterboerner@gmail.com>
Date: Sat, 25 Apr 2015 17:57:05 -0500
Subject: [PATCH] Update README.md

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

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?\""`.