docs: add usage info to readme

2018-12-06 14:29:00 -07:00
1 changed files with 4 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -6,8 +6,11 @@ Github info in your [bitbar](https://getbitbar.com/).

 # Usage

+Add the following to your bitbar plugins path:
+
 ```
-const info = require('github-info');
+#!/usr/bin/env node
+const info = require('path/to/github-info');

 info({
 	username: 'w33ble',