diff --git a/README.md b/README.md index 5434718..05e1a0b 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 + +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) \ No newline at end of file