Skip to content

Commit 3f7cc7d

Browse files
authored
documentation updates (#126)
2 parents 6405881 + d8327b0 commit 3f7cc7d

4 files changed

Lines changed: 17 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="docs/appIcon.svg" width="100px" alt="GitHub Readme Stats" />
2+
<img src="docs/appIcon.svg" width="100px" alt="GitHub Stats Extended Logo" />
33
<h1>GitHub Stats Extended</h1>
44
<p>Dynamically generate GitHub stats for your READMEs.</p>
55
<a href="https://github-stats-extended.vercel.app/api?username=anuraghazra"><img src="https://github-stats-extended.vercel.app/api?username=anuraghazra"></a>

apps/backend/.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "GitHub Readme Stats Dev",
2+
"name": "GitHub Stats Extended Dev",
33
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
44
"features": {
55
"ghcr.io/devcontainers/features/node:1": { "version": "22" }

docs/advanced_documentation.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Use `&theme=THEME_NAME` parameter like so :
7272

7373
#### All inbuilt themes
7474

75-
GitHub Readme Stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
75+
GitHub Stats Extended comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
7676

77-
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/>
77+
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Stats Extended Themes" width="600px"/>
7878

7979
You can look at a preview for [all available themes](../backend/themes/README.md) or checkout the [theme config file](../backend/themes/index.js). Please note that we paused the addition of new themes to decrease maintenance efforts; all pull requests related to new themes will be closed.
8080

@@ -187,7 +187,7 @@ You can customize the appearance of all your cards however you wish with URL par
187187
| `border_radius` | Corner rounding on the card. | number | `4.5` |
188188

189189
> [!WARNING]
190-
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have the following default cache hours: stats card - 24 hours, top languages card - 144 hours (6 days), pin card - 240 hours (10 days), gist card - 48 hours (2 days), and wakatime card - 24 hours. If you want the data on your cards to be updated more often you can [deploy your own instance](deploy.md) and set [environment variable](deploy.md#available-environment-variables) `CACHE_SECONDS` to a value of your choosing.
190+
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Cards generated by [https://github-stats-extended.vercel.app/](https://github-stats-extended.vercel.app/frontend) are cached for a few hours or days, depending on server load. If you want the data on your cards to be updated more often you can [deploy your own instance](deploy.md) and set [environment variable](deploy.md#available-environment-variables) `CACHE_SECONDS` to a value of your choosing. Or you can use the [GitHub Action workflow](https://github.com/stats-organization/github-readme-stats-action).
191191
192192
##### Gradient in bg\_color
193193

@@ -415,6 +415,7 @@ You can customize the appearance and behavior of the top languages card using th
415415
| `role` | Include repositories where the user has one of the specified [roles](https://docs.github.com/en/graphql/reference/enums#repositoryaffiliation) (OWNER, ORGANIZATION_MEMBER, COLLABORATOR). | string (comma-separated values) | `OWNER` |
416416
| `custom_title` | Sets a custom title for the card. | string | `Most Used Languages` |
417417
| `disable_animations` | Disables all animations in the card. | boolean | `false` |
418+
| `prog_bar_bg_color` | Background color of the bars. (Applies only to `normal` layout.) | string (hex color) | `#ddd` |
418419
| `hide_progress` | Uses the compact layout option, hides percentages, and removes the bars. | boolean | `false` |
419420
| `size_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `1` |
420421
| `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` |

docs/deploy.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Click on the deploy button to get started!
145145

146146
### Available environment variables
147147

148-
GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include:
148+
GitHub Stats Extended provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include:
149149

150150
<table>
151151
<thead>
@@ -161,6 +161,16 @@ GitHub Readme Stats provides several environment variables that can be used to c
161161
<td>Sets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).</td>
162162
<td>Any positive integer or <code>0</code> to disable caching</td>
163163
</tr>
164+
<tr>
165+
<td><code>UPDATE_AFTER_HOURS</code></td>
166+
<td>Sets the duration in hours after which the server <a href="fork.md#improved-performance-and-latency">proactively regenerates</a> a previously requested card.</td>
167+
<td>Any int or float</td>
168+
</tr>
169+
<tr>
170+
<td><code>DELETE_AFTER_HOURS</code></td>
171+
<td>Sets the duration in hours after which the server stops <a href="fork.md#improved-performance-and-latency">proactively regenerating</a> a previously requested card if it hasn't been requested again in the meantime.</td>
172+
<td>Any int or float</td>
173+
</tr>
164174
<tr>
165175
<td><code>WHITELIST</code></td>
166176
<td>A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.</td>

0 commit comments

Comments
 (0)