|
|
|
@@ -84,9 +84,9 @@
|
|
|
|
|
- [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
|
|
|
|
|
- [Stats and top languages cards](#stats-and-top-languages-cards)
|
|
|
|
|
- [Pinning repositories](#pinning-repositories)
|
|
|
|
|
- [Deploy on your own](#deploy-on-your-own)
|
|
|
|
|
- [GitHub Actions (Recommended)](#github-actions-recommended)
|
|
|
|
|
- [Self-hosted (Vercel/Other) (Recommended)](#self-hosted-vercelother-recommended)
|
|
|
|
|
- [Deploy on your own (recommended)](#deploy-on-your-own-recommended)
|
|
|
|
|
- [GitHub Actions](#github-actions)
|
|
|
|
|
- [Self-hosted (Vercel/Other)](#self-hosted-vercelother)
|
|
|
|
|
- [First step: get your Personal Access Token (PAT)](#first-step-get-your-personal-access-token-pat)
|
|
|
|
|
- [On Vercel](#on-vercel)
|
|
|
|
|
- [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
|
|
|
|
@@ -96,10 +96,10 @@
|
|
|
|
|
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
# Important Notices <!-- omit in toc -->
|
|
|
|
|
# Important Notices<!-- omit in toc -->
|
|
|
|
|
|
|
|
|
|
> [!IMPORTANT]
|
|
|
|
|
> The public Vercel instance at `https://github-readme-stats.vercel.app/api` is best-effort and can be unreliable due to rate limits and traffic spikes (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). We use caching to improve stability (see [common options](#common-options)), but for reliable cards we recommend [self-hosting](#deploy-on-your-own) (Vercel or other) or using the [GitHub Actions workflow](#github-actions-recommended) to generate cards in your [profile repository](https://docs.github.com/en/account-and-profile/how-tos/profile-customization/managing-your-profile-readme).
|
|
|
|
|
> The public Vercel instance at `https://github-readme-stats.vercel.app/api` is best-effort and can be unreliable due to rate limits and traffic spikes (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). We use caching to improve stability (see [common options](#common-options)), but for reliable cards we recommend [self-hosting](#deploy-on-your-own-recommended) (Vercel or other) or using the [GitHub Actions workflow](#github-actions) to generate cards in your [profile repository](https://docs.github.com/en/account-and-profile/how-tos/profile-customization/managing-your-profile-readme).
|
|
|
|
|
|
|
|
|
|
<img alt="Uptime Badge" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fgithub-readme-stats-git-monitoring-github-readme-stats-team.vercel.app%2Fapi%2Fstatus%2Fup%3Ftype%3Dshields">
|
|
|
|
|
|
|
|
|
@@ -117,7 +117,7 @@ Change the `?username=` value to your GitHub username.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
> [!WARNING]
|
|
|
|
|
> By default, the stats card only shows statistics like stars, commits, and pull requests from public repositories. To show private statistics on the stats card, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
|
|
|
|
|
> By default, the stats card only shows statistics like stars, commits, and pull requests from public repositories. To show private statistics on the stats card, you should [deploy your own instance](#deploy-on-your-own-recommended) using your own GitHub API token.
|
|
|
|
|
|
|
|
|
|
> [!NOTE]
|
|
|
|
|
> Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the [Japanese academic grading](https://wikipedia.org/wiki/Academic_grading_in_Japan) system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, reviews, issues, stars, and followers), based on the cumulative distribution function of the [exponential](https://wikipedia.org/wiki/exponential_distribution) and the [log-normal](https://wikipedia.org/wiki/Log-normal_distribution) distributions. The implementation can be investigated at [src/calculateRank.js](https://github.com/anuraghazra/github-readme-stats/blob/master/src/calculateRank.js). The circle around the rank shows 100 minus the global percentile.
|
|
|
|
@@ -285,7 +285,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 <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-on-your-own) and set [environment variable](#available-environment-variables) `CACHE_SECONDS` to a value of your choosing.
|
|
|
|
|
> 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-on-your-own-recommended) and set [environment variable](#available-environment-variables) `CACHE_SECONDS` to a value of your choosing.
|
|
|
|
|
|
|
|
|
|
##### Gradient in bg\_color
|
|
|
|
|
|
|
|
|
@@ -462,7 +462,7 @@ Use `show_owner` query option to include the gist's owner username
|
|
|
|
|
The top languages card shows a GitHub user's most frequently used languages.
|
|
|
|
|
|
|
|
|
|
> [!WARNING]
|
|
|
|
|
> By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
|
|
|
|
|
> By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own-recommended) using your own GitHub API token.
|
|
|
|
|
|
|
|
|
|
> [!NOTE]
|
|
|
|
|
> Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats.
|
|
|
|
@@ -798,7 +798,7 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
|
|
|
|
|
|
|
|
|
|
# Deploy on your own (recommended)
|
|
|
|
|
|
|
|
|
|
Because the public endpoint is [not reliable](#Important-Notices), we recommend self-deployment via GitHub Actions or your own hosted instance. GitHub Actions is the simplest setup with static SVGs stored in your repo but less frequent updates, while self-hosting takes more work and can serve fresher stats (with caching).
|
|
|
|
|
Because the public endpoint is [not reliable](#important-notices), we recommend self-deployment via GitHub Actions or your own hosted instance. GitHub Actions is the simplest setup with static SVGs stored in your repo but less frequent updates, while self-hosting takes more work and can serve fresher stats (with caching).
|
|
|
|
|
|
|
|
|
|
## GitHub Actions
|
|
|
|
|
|
|
|
|
@@ -811,14 +811,18 @@ name: Update README cards
|
|
|
|
|
|
|
|
|
|
on:
|
|
|
|
|
schedule:
|
|
|
|
|
- cron: "0 3 * * *"
|
|
|
|
|
- cron: "0 0 * * *" # Runs once daily at midnight
|
|
|
|
|
workflow_dispatch:
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
|
|
|
|
|
permissions:
|
|
|
|
|
contents: write
|
|
|
|
|
|
|
|
|
|
steps:
|
|
|
|
|
- uses: actions/checkout@v4
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
|
|
|
|
|
- name: Generate stats card
|
|
|
|
|
uses: readme-tools/github-readme-stats-action@v1
|
|
|
|
@@ -830,8 +834,8 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Commit cards
|
|
|
|
|
run: |
|
|
|
|
|
git config user.name "github-actions"
|
|
|
|
|
git config user.email "github-actions@users.noreply.github.com"
|
|
|
|
|
git config user.name "github-actions[bot]"
|
|
|
|
|
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
|
|
|
git add profile/*.svg
|
|
|
|
|
git commit -m "Update README cards" || exit 0
|
|
|
|
|
git push
|
|
|
|
|
martin-mfg