From f7a741245d74e613ef145092ef252db7b47b1661 Mon Sep 17 00:00:00 2001
From: joe fleming <joe.fleming@gmail.com>
Date: Thu, 6 Dec 2018 14:27:59 -0700
Subject: [PATCH] docs: add usage info to readme

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5434718..e09dec6 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,24 @@
 # github-info
 
-Github info in your bitbar.
+Github info in your [bitbar](https://getbitbar.com/).
 
 ![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
 
+# Usage
+
+Clone this repo and add the following to your bitbar plugins path:
+
+```js
+#!/usr/bin/env node
+const info = require('path/to/github-info');
+
+info({
+	username: 'w33ble',
+	token: 'not required, but highly recommended',
+	repos: [ 'org/repo', 'w33ble/emo' ]
+});
+```
+
 #### License
 
 MIT © [w33ble](https://github.com/w33ble)
\ No newline at end of file