diff --git a/README.md b/README.md index e92eb45..df88358 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ # GitHub Contributions +
+ A menubar app, which shows github contributions chart for the last 7 days, similar to the one on the github's user page: - -![screenshot1](./screenshots/screenshot1.png) ++ +
When clicked it shows some information about the user: - ++ +
+ ## Themes @@ -22,7 +38,24 @@ The app can be customized and use one of the following themes | teal | | +# Installation + +- install [Hammerspoon](http://www.hammerspoon.org/) - a powerful automation tool for OS X + - Manually: + + Download the [latest release](https://github.com/Hammerspoon/hammerspoon/releases/latest), and drag Hammerspoon.app from your Downloads folder to Applications. + - Homebrew: -# Installation + ```brew install hammerspoon --cask``` + - download [github-contributions.spoon](https://github.com/fork-my-spoons/github-contributions.spoon/releases/latest/download/github-contributions.spoon.zip), unzip and double click on a .spoon file. It will be installed under ~/.hammerspoon/Spoons folder. + - open ~/.hammerspoon/init.lua and add the following snippet: -TDB +```lua +-- github contributions +hs.loadSpoon("github-contributions") +spoon['github-contributions']:setup({ + usernames = {'streetturtle', 'fork-my-spoons', 'mgubaidullin'}, -- use on or multiple accounts + -- theme = 'pink' +}) +spoon['github-contributions']:start() +```