update readme

fork-my-spoons · Apr 6, 2021 · 0f1015a · 0f1015a
1 parent f47a9a0
commit 0f1015a
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,27 @@
 # GitHub Contributions
 
-TBD
+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:
+
+![screenshot2](./screenshots/screenshot2.png)
+
+## Themes
+
+The app can be customized and use one of the following themes
+
+| theme name | screenshot |
+|---|---|
+| classic | ![classic](./screenshots/classic.png) |
+| dracula | ![classic](./screenshots/dracula.png) |
+| leftpad | ![classic](./screenshots/leftpad.png) |
+| pink | ![classic](./screenshots/pink.png) |
+| teal | ![classic](./screenshots/teal.png) |
+
+
+
+# Installation 
+
+TDB
diff --git a/init.lua b/init.lua
@@ -109,7 +109,7 @@ function obj:start()
                 self.color_levels[#self.color_levels + 1] = i
             end
 
-            for i = #self.color_levels - 5 - 6, #self.color_levels - 5 do
+            for i = #self.color_levels - 5 - 10, #self.color_levels - 5 -4  do
                 contributions_text = contributions_text 
                     .. hs.styledtext.new('●', { color = { hex = obj.color_mapping[self.theme][ self.color_levels[i] + 0 ] } } )
             end

diff --git a/screenshots/classic.png b/screenshots/classic.png
diff --git a/screenshots/dracula.png b/screenshots/dracula.png
diff --git a/screenshots/leftpad.png b/screenshots/leftpad.png
diff --git a/screenshots/pink.png b/screenshots/pink.png
diff --git a/screenshots/screenshot1.png b/screenshots/screenshot1.png
diff --git a/screenshots/screenshot2.png b/screenshots/screenshot2.png
diff --git a/screenshots/teal.png b/screenshots/teal.png