Skip to content

Commit 5d44d33

Browse files
committed
Update documentation
1 parent 31875ff commit 5d44d33

2 files changed

Lines changed: 26 additions & 13 deletions

File tree

docs/privacy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Dashy supports [Widgets](/docs/widgets) for displaying dynamic content. Below is
229229
| [Flight Data](/docs/widgets#flight-data) | `https://aerodatabox.p.rapidapi.com` | [AeroDataBox Privacy Policy](https://www.aerodatabox.com/#h.p_cxtiyzwf_wqd) |
230230
| [Astronomy Picture of the Day](/docs/widgets#astronomy-picture-of-the-day) | `https://apod.as93.net` | [NASA's Privacy Policy](https://www.nasa.gov/privacy/) (via a proxy run by Dashy's author) |
231231
| [GitHub Trending](/docs/widgets#github-trending) | `https://trend.doforce.xyz` | No Policy Available |
232-
| [GitHub Profile Stats](/docs/widgets#github-profile-stats) | `https://github-readme-stats.vercel.app` | [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement) |
232+
| [GitHub Profile Stats](/docs/widgets#github-profile-stats) | `https://api.github.com` | [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement) |
233233
| [Healthchecks Status](/docs/widgets#healthchecks-status) | `https://healthchecks.io` | [Health-Checks Privacy Policy](https://healthchecks.io/privacy/) |
234234
| [Hacker News Trending](/docs/widgets#hackernews-trending) | `https://hacker-news.firebaseio.com` | [Y Combinator Privacy Policy](https://www.ycombinator.com/legal#privacy) |
235235
| [Minecraft Server Status](/docs/widgets#minecraft-server) | `https://api.mcsrvstat.us` | No Policy Available |

docs/widgets.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,38 +1188,51 @@ Displays currently trending projects on GitHub. Optionally specify a language an
11881188

11891189
### GitHub Profile Stats
11901190

1191-
Display stats from your GitHub profile, using embedded cards from [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
1191+
Shows GitHub user stats (if `username`) and repos stats (for each repo in `repos`). Fetched from the GitHub API.
11921192

1193-
<p align="center"><img width="380" src="https://pixelflare.cc/alicia/dashy/github-stats" /></p>
1193+
<p align="center"><img width="600" src="https://pixelflare.cc/alicia/dashy/github-stats-widget" /></p>
11941194

11951195
#### Options
11961196

11971197
**Field** | **Type** | **Required** | **Description**
11981198
--- | --- | --- | ---
1199-
**`username`** | `string` | Required | The GitHub username to fetch info for. E.g. `lissy93`. (Not required if `hideProfileCard` and `hideLanguagesCard` are both set to `true`)
1200-
**`hideProfileCard`** | `boolean` | _Optional_ | If set to `true`, the users profile card will not be shown. Defaults to `false`
1201-
**`hideLanguagesCard`** | `boolean` | _Optional_ | If set to `true`, the users top languages card will not be shown. Defaults to `false`
1202-
**`repos`** | `array` | _Optional_ | If you'd like to also display stats for some GitHub repositories, then add an array or repo names here. Specified as `[username]/[repo-name]`, e.g. `lissy93/dashy`
1199+
**`username`** | `string` | _Optional_ | A GitHub username, e.g. `lissy93`. If this is set, a profile card is shown, if it's unset the card isn't shown
1200+
**`repos`** | `array` | _Optional_ | A list of repositories to show stats for, each specified as `[owner]/[repo]`, e.g. `lissy93/dashy`
1201+
**`token`** | `string` | _Optional_ | An optional [GitHub token](https://github.com/settings/tokens). Used to raise the API rate limit from 60 to 5,000 requests per hour (can be set directly, or as an environment variable)
12031202

12041203
#### Example
12051204

12061205
```yaml
12071206
- type: github-profile-stats
12081207
options:
1209-
username: Lissy93
1210-
hideLanguagesCard: true
1208+
username: lissy93
1209+
repos:
1210+
- lissy93/dashy
1211+
- lissy93/portainer-templates
1212+
- lissy93/web-check
1213+
```
1214+
1215+
Or just show the user's profile card:
1216+
```yaml
1217+
- type: github-profile-stats
1218+
options:
1219+
username: octocat
1220+
```
1221+
1222+
Or just show repo(s)
1223+
```yaml
1224+
- type: github-profile-stats
1225+
options:
12111226
repos:
12121227
- lissy93/dashy
1213-
- lissy93/personal-security-checklist
1214-
- lissy93/twitter-sentiment-visualisation
12151228
```
12161229

12171230
#### Info
12181231

12191232
- **CORS**: 🟢 Enabled
1220-
- **Auth**: 🟢 Not Required
1233+
- **Auth**: 🟡 Optional (a `token` raises the rate limit)
12211234
- **Price**: 🟢 Free
1222-
- **Host**: Managed Instance or Self-Hosted (see [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats))
1235+
- **Host**: GitHub ([docs.github.com/en/rest](https://docs.github.com/en/rest))
12231236
- **Privacy**: _See [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement)_
12241237

12251238
---

0 commit comments

Comments
 (0)