1.0.0

AUTHORS.md

@@ -0,0 +1,3 @@
+### Authors
+
+- joe fleming ([w33ble](https://github.com/w33ble))

CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+#### 1.0.0 (6 December 2018)
+- docs: add usage info to readme [`f7a7412`](https://git.w33ble.com/w33ble/github-info-bitbar/commit/f7a741245d74e613ef145092ef252db7b47b1661)
+- feat: working bitbar output [`9a96270`](https://git.w33ble.com/w33ble/github-info-bitbar/commit/9a96270df6dbd340c1bae68116f7c43d5dd956cf)

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)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-info",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Github info in your bitbar",
   "main": "index",
   "module": "index.mjs",