Skip to content

Commit cc85ab2

Browse files
committed
Update README.md
1 parent e7b7d2b commit cc85ab2

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

GitHubStats Widget/README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,23 @@ const username = "your_github_username"; // Replace with your username
8686
Widget behavior is controlled through **widget parameters**. Set these when configuring your widget on the home screen.
8787

8888
### 📊 **Basic Profile Stats**
89-
Display your overall GitHub profile statistics:
9089

91-
```text
92-
auto
90+
By defualt display your overall GitHub profile statistics with the `auto` theme: auto theme (adapts to iOS dark/light mode).
91+
92+
```
93+
indigo
9394
```
94-
Shows your complete GitHub profile with auto theme (adapts to iOS dark/light mode).
95+
96+
Themes:
97+
98+
| Theme | Description | Theme | Description |
99+
|-------|-------------|-------|-------------|
100+
| `auto` | Adapts to iOS appearance | `day` | Bright sky theme |
101+
| `light` | Clean light theme | `gray` | Sophisticated gray |
102+
| `dark` | Sleek dark theme | `green` | Nature-inspired |
103+
| `blue` | Ocean blue gradient | `gitgreen` | GitHub green |
104+
| `night` | Deep space theme | `indigo` | Purple-blue gradient |
105+
95106

96107
### 📦 **Repository-Specific Stats**
97108
Get detailed statistics for a specific repository:
@@ -121,22 +132,9 @@ Display a GitHub-style contribution heatmap:
121132
heatmap,theme_name
122133
```
123134

124-
### 🎨 **Theme Selection**
125-
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:
135+
Widget heatmap Themes:
139136
> so when using parameter like, "heatmap,{heatmapThemeName}"
137+
> NOTE: these theme only work with the heatmap only.
140138
141139
| Theme | Description | Theme | Description |
142140
|-------|-------------|-------|-------------|

0 commit comments

Comments
 (0)