$ gh-notifier

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations]    

> Receive desktop notifications from your GitHub dashboard.


:cloud: Installation

You can install the package globally and use it as command line tool:

``sh


Using npm

npm install --global gh-notifier

Using yarn

yarn global add gh-notifier
`


Then, run gh-notifier --help and see what the CLI tool can do.


`
$ gh-notifier --help
Usage: gh-notifier [options]

Options:
-i, --interval The delay between requests (milliseconds).
-t, --token The GitHub token.
-d, --daemon Daemonize the process.
-h, --help Displays this help.
-v, --version Displays version information.

Examples:
gh-notifier -t 9b0...ab1
gh-notifier -t 9b0...ab1 -i 10000 # every ten seconds


`

:clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install gh-notifier (or yarn add gh-notifier):

`js
const notify = require("gh-notifier");

// Check every 3 seconds
notify("b80688e1...fc5ba8c4", 3000, (err, data) => {
console.log(err || ${data.title[0]._} ${data.published[0]});
});
// GhitaB forked IonicaBizau/Resources to GhitaB/Resources 2016-01-12T09:03:22Z
`




:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.




:yum: How to contribute

Have an idea? Found a bug? See [how to contribute][contributing].

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`


Thanks! :heart:

:scroll: License

[MIT][license] © [Ionică Bizău][website]

[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW