11# 📊 GitHub Stats Widget
22
3- ![ License: MIT] (https://img.shields.i---
3+ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-blue?style=flat )
4+ ![ Built with JavaScript] ( https://img.shields.io/badge/Built%20with-JavaScript-F7DF1E?logo=javascript&style=flat )
5+ ![ Platform] ( https://img.shields.io/badge/Platform-iOS-blue?style=flat&logo=apple )
6+ ![ Scriptable] ( https://img.shields.io/badge/Scriptable-Compatible-success?style=flat&logo=scriptable )
7+ ![ Themes] ( https://img.shields.io/badge/Themes-20%2B-purple?style=flat )
8+ ![ Widget Sizes] ( https://img.shields.io/badge/Sizes-Small%2C%20Medium%2C%20Large-informational?style=flat )
9+ ![ Offline Support] ( https://img.shields.io/badge/Offline-Supported-green?style=flat )
10+ ![ Heatmap] ( https://img.shields.io/badge/Heatmap-Enabled-orange?style=flat )
11+
12+
13+
14+ <img src =" https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/githubstats/githubstats_showcase.png " >
15+
16+ ** A comprehensive GitHub statistics widget for iOS** that displays your GitHub activity, contributions, and repository metrics directly on your home screen. Built for the Scriptable app with advanced features including ** offline caching** , ** contribution heatmaps** , and ** 20+ stunning themes** .
17+
18+ > ✨ ** New Features** : Offline support with intelligent caching, GitHub contribution heatmaps, enhanced themes, and repository-specific statistics
19+
420
521## 🚀 Quick Setup
622
@@ -36,22 +52,7 @@ const username = "your_github_username"; // Replace with your username
36521 . Long press on your home screen
37532 . Tap the "+" button to add a widget
38543 . Search for "Scriptable" and select your preferred size
39- 4 . Configure the widget to run your GitHub Stats scriptT-blue?style=flat)
40- ![ Built with JavaScript] ( https://img.shields.io/badge/Built%20with-JavaScript-F7DF1E?logo=javascript&style=flat )
41- ![ Platform] ( https://img.shields.io/badge/Platform-iOS-blue?style=flat&logo=apple )
42- ![ Scriptable] ( https://img.shields.io/badge/Scriptable-Compatible-success?style=flat&logo=scriptable )
43- ![ Themes] ( https://img.shields.io/badge/Themes-20%2B-purple?style=flat )
44- ![ Widget Sizes] ( https://img.shields.io/badge/Sizes-Small%2C%20Medium%2C%20Large-informational?style=flat )
45- ![ Offline Support] ( https://img.shields.io/badge/Offline-Supported-green?style=flat )
46- ![ Heatmap] ( https://img.shields.io/badge/Heatmap-Enabled-orange?style=flat )
47-
48- <img src =" https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/githubstats/githubstats_showcase.png " >
49-
50- ** A comprehensive GitHub statistics widget for iOS** that displays your GitHub activity, contributions, and repository metrics directly on your home screen. Built for the Scriptable app with advanced features including ** offline caching** , ** contribution heatmaps** , and ** 20+ stunning themes** .
51-
52- > 🚀 ** New Features** : Offline support with intelligent caching, GitHub contribution heatmaps, enhanced themes, and repository-specific statistics
53-
54- ---
55+ 4 . Configure the widget to run your GitHub Stats script
5556
5657## ✨ Features
5758
@@ -79,14 +80,6 @@ const username = "your_github_username"; // Replace with your username
7980- ** 📊 Standard themes** - ` light ` , ` dark ` , ` blue ` , ` night ` , ` day ` , ` gray ` , ` green ` , ` gitgreen ` , ` indigo `
8081- ** � Heatmap themes** - ` forestCalm ` , ` forestCanopy ` , ` cyberPurple ` , ` sunsetGold ` , ` nordBlueV1 ` , ` nordBlueV2 ` , ` sunsetDusk ` , ` earthyWarm ` , ` arcticIce `
8182
82- ### 📱 ** Responsive Widget Layouts**
83-
84- ### 🌐 ** Smart Connectivity**
85-
86- ### 🔧 ** Technical Features**
87-
88-
89-
9083
9184## 🎛️ Widget Configuration
9285
@@ -130,31 +123,30 @@ heatmap,theme_name
130123
131124### 🎨 ** Theme Selection**
132125
133- #### ** Standard Widget Themes:**
134- - ` auto ` - Adapts to iOS appearance
135- - ` light ` - Clean light theme
136- - ` dark ` - Sleek dark theme
137- - ` blue ` - Ocean blue gradient
138- - ` night ` - Deep space theme
139- - ` day ` - Bright sky theme
140- - ` gray ` - Sophisticated gray
141- - ` green ` - Nature-inspired
142- - ` gitgreen ` - GitHub green
143- - ` indigo ` - Purple-blue gradient
144-
145- #### ** Heatmap-Specific Themes:**
146- - ` auto ` - Adapts to iOS appearance
147- - ` light ` / ` dark ` - Standard GitHub colors
148- - ` red ` - Red intensity theme
149- - ` green ` - Green contribution theme
150- - ` forestCalm ` - Peaceful forest greens
151- - ` forestCanopy ` - Rich forest colors
152- - ` cyberPurple ` - Futuristic purple
153- - ` sunsetGold ` - Warm sunset colors
154- - ` nordBlueV1 ` / ` nordBlueV2 ` - Nordic blue themes
155- - ` sunsetDusk ` - Evening sky colors
156- - ` earthyWarm ` - Warm earth tones
157- - ` arcticIce ` - Cool arctic theme
126+
127+ Available values for the third parameter,\
128+ For Widget stats Themes:
129+
130+ | Theme | Description | Theme | Description |
131+ | -------| -------------| -------| -------------|
132+ | ` auto ` | Adapts to iOS appearance | ` day ` | Bright sky theme |
133+ | ` light ` | Clean light theme | ` gray ` | Sophisticated gray |
134+ | ` dark ` | Sleek dark theme | ` green ` | Nature-inspired |
135+ | ` blue ` | Ocean blue gradient | ` gitgreen ` | GitHub green |
136+ | ` night ` | Deep space theme | ` indigo ` | Purple-blue gradient |
137+
138+ For Widget heatmap Themes:
139+ > so when using parameter like, "heatmap,{heatmapThemeName}"
140+
141+ | Theme | Description | Theme | Description |
142+ | -------| -------------| -------| -------------|
143+ | ` auto ` | Adapts to iOS appearance | ` cyberPurple ` | Futuristic purple theme |
144+ | ` light ` | Standard GitHub light | ` sunsetGold ` | Warm sunset colors |
145+ | ` dark ` | Standard GitHub dark | ` nordBlueV1 ` | Nordic blue variant 1 |
146+ | ` red ` | Red intensity theme | ` nordBlueV2 ` | Nordic blue variant 2 |
147+ | ` green ` | Green contribution theme | ` sunsetDusk ` | Evening sky colors |
148+ | ` forestCalm ` | Peaceful forest greens | ` earthyWarm ` | Warm earth tones |
149+ | ` forestCanopy ` | Rich forest colors | ` arcticIce ` | Cool arctic theme |
158150
159151### 💡 ** Configuration Examples**
160152
@@ -167,8 +159,6 @@ heatmap,theme_name
167159| ` currstreak,auto ` | Current streak with auto theme | Streak count adapting to iOS theme |
168160| ` repos,green ` | Repository count with green theme | Total public repos in green |
169161
170- ---
171-
172162## � Widget Layout Guide
173163
174164### ** Small Widget (1x1)**
@@ -317,53 +307,6 @@ console.log(Keychain.get("github_token_here"));
317307- 🎨 ** Adaptive themes** that respond to iOS appearance
318308- 📊 ** Professional value formatting** (1.2k, 345m)
319309
320- ### 📐 Widget Layouts
321-
322- | Size | Layout Details |
323- | ------ | ---------------------------------------------- |
324- | Small | Focused repo or profile stat + minimal details |
325- | Medium | Header + 5 stat lines |
326- | Large | Two-column detailed layout (up to 8 metrics) |
327-
328- ### 🎨 Themes
329-
330- Available values for the third parameter,\
331- For Widget stats Themes:
332-
333- | Theme | Description | Theme | Description |
334- | -------| -------------| -------| -------------|
335- | ` auto ` | Adapts to iOS appearance | ` day ` | Bright sky theme |
336- | ` light ` | Clean light theme | ` gray ` | Sophisticated gray |
337- | ` dark ` | Sleek dark theme | ` green ` | Nature-inspired |
338- | ` blue ` | Ocean blue gradient | ` gitgreen ` | GitHub green |
339- | ` night ` | Deep space theme | ` indigo ` | Purple-blue gradient |
340-
341- For Widget heatmap Themes:
342- > so when using parameter like, "heatmap,{heatmapThemeName}"
343-
344- | Theme | Description | Theme | Description |
345- | -------| -------------| -------| -------------|
346- | ` auto ` | Adapts to iOS appearance | ` cyberPurple ` | Futuristic purple theme |
347- | ` light ` | Standard GitHub light | ` sunsetGold ` | Warm sunset colors |
348- | ` dark ` | Standard GitHub dark | ` nordBlueV1 ` | Nordic blue variant 1 |
349- | ` red ` | Red intensity theme | ` nordBlueV2 ` | Nordic blue variant 2 |
350- | ` green ` | Green contribution theme | ` sunsetDusk ` | Evening sky colors |
351- | ` forestCalm ` | Peaceful forest greens | ` earthyWarm ` | Warm earth tones |
352- | ` forestCanopy ` | Rich forest colors | ` arcticIce ` | Cool arctic theme |
353-
354- ### 🛠 Example Use Cases
355-
356- ``` text
357- // Shows pull requests on a repo with indigo theme
358- rushhiii/Scriptable-IOSWidgets,prs,indigo
359-
360- // Shows 2025 commits in blue theme
361- commits,blue
362-
363- // Shows profile stats in dark mode
364- night
365- ```
366-
367310### 📎 Notes
368311
369312* All API requests use GitHub’s GraphQL v4 and REST API v3.
0 commit comments