diff --git a/README.md b/README.md index 13f33c0f..f9dfb45e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- GitHub Readme Stats + GitHub Stats Extended Logo

GitHub Stats Extended

Dynamically generate GitHub stats for your READMEs.

diff --git a/apps/backend/.devcontainer/devcontainer.json b/apps/backend/.devcontainer/devcontainer.json index cbeb9162..7e8a6f89 100644 --- a/apps/backend/.devcontainer/devcontainer.json +++ b/apps/backend/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "GitHub Readme Stats Dev", + "name": "GitHub Stats Extended Dev", "image": "mcr.microsoft.com/devcontainers/base:ubuntu", "features": { "ghcr.io/devcontainers/features/node:1": { "version": "22" } diff --git a/docs/advanced_documentation.md b/docs/advanced_documentation.md index 640677c2..10965e45 100644 --- a/docs/advanced_documentation.md +++ b/docs/advanced_documentation.md @@ -72,9 +72,9 @@ Use `&theme=THEME_NAME` parameter like so : #### All inbuilt themes -GitHub Readme Stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`). +GitHub Stats Extended comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`). -GitHub Readme Stats Themes +GitHub Stats Extended Themes 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. @@ -187,7 +187,7 @@ You can customize the appearance of all your cards however you wish with URL par | `border_radius` | Corner rounding on the card. | number | `4.5` | > [!WARNING] -> We use caching to decrease the load on our servers (see ). 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. +> We use caching to decrease the load on our servers (see ). 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). ##### Gradient in bg\_color @@ -415,6 +415,7 @@ You can customize the appearance and behavior of the top languages card using th | `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` | | `custom_title` | Sets a custom title for the card. | string | `Most Used Languages` | | `disable_animations` | Disables all animations in the card. | boolean | `false` | +| `prog_bar_bg_color` | Background color of the bars. (Applies only to `normal` layout.) | string (hex color) | `#ddd` | | `hide_progress` | Uses the compact layout option, hides percentages, and removes the bars. | boolean | `false` | | `size_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `1` | | `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` | diff --git a/docs/deploy.md b/docs/deploy.md index 8b884102..1ad48734 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -145,7 +145,7 @@ Click on the deploy button to get started! ### Available environment variables -GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include: +GitHub Stats Extended provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include: @@ -161,6 +161,16 @@ GitHub Readme Stats provides several environment variables that can be used to c + + + + + + + + + +
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). Any positive integer or 0 to disable caching
UPDATE_AFTER_HOURSSets the duration in hours after which the server proactively regenerates a previously requested card.Any int or float
DELETE_AFTER_HOURSSets the duration in hours after which the server stops proactively regenerating a previously requested card if it hasn't been requested again in the meantime.Any int or float
WHITELIST A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.