docs: add usage info to readme
This commit is contained in:
17
README.md
17
README.md
@@ -1,9 +1,24 @@
|
||||
# github-info
|
||||
|
||||
Github info in your bitbar.
|
||||
Github info in your [bitbar](https://getbitbar.com/).
|
||||
|
||||

|
||||
|
||||
# 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)
|
||||
Reference in New Issue
Block a user