From b7f5efa8e9eb3b70678611680668222fcd219312 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Sun, 16 May 2021 21:23:38 -0400 Subject: [PATCH 1/3] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e92eb45..e908a5d 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ A menubar app, which shows github contributions chart for the last 7 days, similar to the one on the github's user page: -screenshot1 -![screenshot1](./screenshots/screenshot1.png) +

+ screenshot1 +

When clicked it shows some information about the user: -screenshot2 +

+ screenshot2 +

## Themes @@ -22,7 +25,6 @@ The app can be customized and use one of the following themes | teal | teal| - # Installation TDB From 44c99f1999de8468e12098f77ab2cd96d5279a0b Mon Sep 17 00:00:00 2001 From: streetturtle Date: Sun, 16 May 2021 21:30:21 -0400 Subject: [PATCH 2/3] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e908a5d..de3c777 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # GitHub Contributions +

+ + GitHub issues + + + GitHub all releases + + + GitHub release (latest by date) + +

+ A menubar app, which shows github contributions chart for the last 7 days, similar to the one on the github's user page:

@@ -12,6 +24,7 @@ When clicked it shows some information about the user: screenshot2

+ ## Themes The app can be customized and use one of the following themes @@ -25,6 +38,24 @@ The app can be customized and use one of the following themes | teal | teal| -# Installation +# 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: + + ```brew install hammerspoon --cask``` + - download [github-contributions.spoon](https://github.com/fork-my-spoons/gitlab-merge-requests.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() +``` From e8cd2b018fcf0d1df0c7cbf17cf04cfe10404797 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Sun, 16 May 2021 21:32:31 -0400 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index de3c777..df88358 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ The app can be customized and use one of the following themes - Homebrew: ```brew install hammerspoon --cask``` - - download [github-contributions.spoon](https://github.com/fork-my-spoons/gitlab-merge-requests.spoon/releases/latest/download/github-contributions.spoon.zip), unzip and double click on a .spoon file. It will be installed under ~/.hammerspoon/Spoons folder. + - 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: ```lua