docs: add usage info to readme

This commit is contained in:
2018-12-06 14:27:59 -07:00
parent da786a6e02
commit 6e777936bf

View File

@@ -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
Add the following to your bitbar plugins path:
```
#!/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)