Skip to content

Commit c0e3a37

Browse files
committed
Update README.md
1 parent 30c9057 commit c0e3a37

1 file changed

Lines changed: 38 additions & 122 deletions

File tree

GitHubStats Widget/README.md

Lines changed: 38 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -80,21 +80,10 @@ const username = "your_github_username"; // Replace with your username
8080
- **� Heatmap themes** - `forestCalm`, `forestCanopy`, `cyberPurple`, `sunsetGold`, `nordBlueV1`, `nordBlueV2`, `sunsetDusk`, `earthyWarm`, `arcticIce`
8181

8282
### 📱 **Responsive Widget Layouts**
83-
- **Small** - Focused stats or contribution grid
84-
- **Medium** - Comprehensive overview with key metrics
85-
- **Large** - Full dashboard with language breakdown
8683

8784
### 🌐 **Smart Connectivity**
88-
- **📶 Offline support** with intelligent 24-hour caching
89-
- **🔄 Auto-fallback** to cached data when offline
90-
- **⚡ Fast loading** with optimized API calls
91-
- **📡 Network detection** with offline indicators
9285

9386
### 🔧 **Technical Features**
94-
- **🔑 Secure token storage** using iOS Keychain
95-
- **📊 GraphQL + REST API** integration
96-
- **🎯 Efficient caching** system with iCloud sync
97-
- **💻 Programming language** detection and color coding
9887

9988

10089

@@ -183,58 +172,37 @@ heatmap,theme_name
183172
## � Widget Layout Guide
184173

185174
### **Small Widget (1x1)**
186-
**Perfect for:** Quick stats check or contribution heatmap preview
187-
188-
**Profile Mode:**
189-
- Username with GitHub logo
190-
- Current streak with fire emoji
191-
- Annual commits count
192-
- Total contributions
193-
- Repository count
194-
- Follower count
195-
196-
**Repository Mode:**
197-
- Repository name and stat type
198-
- Large formatted stat value
199-
- Clean, focused display
200-
201-
**Heatmap Mode:**
202-
- 7×5 contribution grid
203-
- Month name header
204-
- GitHub logo
205-
- Weekday labels
175+
176+
| Mode | Display Elements | Use Case |
177+
|------|------------------|----------|
178+
| **👤 Profile** | Username + logo, 🔥 streak, 🕒 commits, 📅 contributions, 📦 repos, 👥 followers | Personal stats summary |
179+
| **📦 Repository** | Repo name, large stat value, clean focus | Specific repo metrics |
180+
| **🗺️ Heatmap** | 7×5 contribution grid, month header, weekday labels | Activity visualization |
206181

207182
### **Medium Widget (2x1)**
208-
**Perfect for:** Comprehensive overview
209183

210-
**Features:**
211-
- Full header with username and GitHub logo
212-
- Two-column layout with 10+ metrics:
213-
- Left: Stars earned, annual commits, total commits, issues, PRs
214-
- Right: Current streak, longest streak, repos, followers
215-
- Optimized spacing and typography
216-
- Smart value formatting (e.g., 1.2k, 345m)
184+
| Section | Left Column | Right Column |
185+
|---------|-------------|--------------|
186+
| **Header** | Username + GitHub logo | - |
187+
| **Stats** | ⭐ Stars, 🕒 Commits, 📜 Total commits, ❗ Issues, 🔃 PRs | 🔥 Current streak, 🏆 Longest streak, 📦 Repos, 👥 Followers |
188+
| **Format** | Smart value formatting (1.2k, 345m) | Optimized spacing |
217189

218190
### **Large Widget (2x2)**
219-
**Perfect for:** Complete dashboard experience
220191

221-
**Features:**
222-
- Same comprehensive stats as medium
223-
- **Bonus: Programming language breakdown**
224-
- Top languages with percentages
225-
- Color-coded language indicators
226-
- Two-column language grid
227-
- Maximum information density
228-
- Enhanced visual hierarchy
192+
| Section | Content | Details |
193+
|---------|---------|---------|
194+
| **Header** | Username + GitHub logo | Same as medium |
195+
| **Stats Grid** | All medium widget metrics | Two-column comprehensive view |
196+
| **Languages** | 💻 Programming language breakdown | Color-coded indicators, percentages, two-column grid |
197+
| **Density** | Maximum information | Enhanced visual hierarchy |
229198

230199
### **Heatmap Widgets**
231-
**Contribution Calendar Display:**
232-
- **Medium/Large:** Full 19-week contribution grid
233-
- **Color intensity** based on daily contributions
234-
- **Footer stats:** Current streak + total contributions
235-
- **Responsive design** that adapts to theme colors
236200

237-
---
201+
| Widget Size | Grid | Additional Info |
202+
|-------------|------|-----------------|
203+
| **Small** | 7×5 contribution cells | Month name, GitHub logo, weekday labels |
204+
| **Medium/Large** | Full 19-week grid | Color intensity levels, current streak + total contributions |
205+
| **Features** | Responsive design | Adapts to selected theme colors |
238206

239207
## 🌐 Offline Support & Caching
240208

@@ -256,30 +224,6 @@ heatmap,theme_name
256224
- Manual cache testing available in script
257225
- Robust error handling with fallback strategies
258226

259-
---
260-
261-
## 🎨 Theme Gallery
262-
263-
### **Auto Theme**
264-
Intelligently adapts to your iOS appearance settings:
265-
- **Light mode:** Clean whites and soft greens
266-
- **Dark mode:** Deep space blues with bright accents
267-
268-
### **Signature Themes**
269-
- **🌊 Blue:** Ocean-inspired gradients
270-
- **🌙 Night:** Deep space with stellar accents
271-
- **☀️ Day:** Bright sky blues and crisp whites
272-
- **🌫️ Gray:** Sophisticated storm cloud gradients
273-
274-
### **Heatmap Specialties**
275-
- **🌲 Forest Calm/Canopy:** Nature-inspired greens
276-
- **🚀 Cyber Purple:** Futuristic technology vibes
277-
- **🌅 Sunset Gold/Dusk:** Warm evening colors
278-
- **🏔️ Nordic Blue:** Cool Scandinavian aesthetics
279-
- **❄️ Arctic Ice:** Pristine white and blue tones
280-
281-
---
282-
283227
## ⚙️ Technical Details
284228

285229
### **API Integration**
@@ -306,8 +250,6 @@ Intelligently adapts to your iOS appearance settings:
306250
- **Automatic retry logic** with exponential backoff
307251
- **Fallback to cached data** maintains functionality
308252

309-
---
310-
311253
## 🛠️ Troubleshooting
312254

313255
### **Common Issues**
@@ -352,8 +294,6 @@ console.log(Keychain.get("github_token_here"));
352294
- Cache duration: 24 hours
353295
- iCloud sync required for offline access
354296

355-
---
356-
357297
## 🔄 Changelog & Updates
358298

359299
### **Latest Version Features**
@@ -377,8 +317,6 @@ console.log(Keychain.get("github_token_here"));
377317
- 🎨 **Adaptive themes** that respond to iOS appearance
378318
- 📊 **Professional value formatting** (1.2k, 345m)
379319

380-
---
381-
382320
### 📐 Widget Layouts
383321

384322
| Size | Layout Details |
@@ -387,53 +325,31 @@ console.log(Keychain.get("github_token_here"));
387325
| Medium | Header + 5 stat lines |
388326
| Large | Two-column detailed layout (up to 8 metrics) |
389327

390-
---
391-
392328
### 🎨 Themes
393329

394330
Available values for the third parameter,\
395331
For Widget stats Themes:
396332

397-
* `auto`
398-
* `light`
399-
* `dark`
400-
* `blue`
401-
* `night`
402-
* `day`
403-
* `gray`
404-
* `green`
405-
* `gitgreen`
406-
* `indigo`
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 |
407340

408341
For Widget heatmap Themes:
409342
> so when using parameter like, "heatmap,{heatmapThemeName}"
410343
411-
<div style="disply:flex;">
412-
413-
<div>
414-
415-
* `auto`
416-
* `light`
417-
* `dark`
418-
* `red`
419-
* `green`
420-
* `forestCalm`
421-
* `forestCanopy`
422-
423-
</div>
424-
<div>
425-
426-
* `cyberPurple`
427-
* `sunsetGold`
428-
* `nordBlueV1`
429-
* `nordBlueV2`
430-
* `sunsetDusk`
431-
* `earthyWarm`
432-
* `arcticIce`
433-
434-
</div>
435-
436-
</div>
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 |
437353

438354
### 🛠 Example Use Cases
439355

0 commit comments

Comments
 (0)