From dee337d371e79ce5c1d86535d23a6aa8e9cd93cb Mon Sep 17 00:00:00 2001 From: joe fleming Date: Thu, 6 Dec 2018 14:27:59 -0700 Subject: [PATCH] docs: add usage info to readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5434718..82b468e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ # 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 + +``` +const info = require('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