readme.md

github-reader

Github Client - Viewer for Notifications and News Feed

Built with node-webkit.

Features

• Viewer for mixed Notifications and News Feed
• Growl Notification(for Mac only, relate issue - Implement desktop notifications)
• J,K scroll shortcut
• O : open in browser
• Ctrl + R reload
• Ctrl + f : toggle search bar - gif

Installation

Download latest binary

Multi-platform support

• Windows
• Mac OS X
• Linux 32,64bit

Config

• Create New personal access token
  • require scopes are notifications and user

• Open Config in Github-Reader.app
  • Input Github username
  • Input personal access token
• Save & Reload

UserFilterScript

Filter notifications by using filter script

1. Create UserFilterScript.js
2. Set UserFilterScript file path in config view.

examples/user-filter-example.js: ignore "coveralls" account.

module.exports = function (item) {
    if(item.user_name === "coveralls"){
        return false;
    }
    return true;
};

Develop

npm install

Run apps with node-webkit.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT