Skip to content

Commit 54a7985

Browse files
martin-mfgmartin-mfg
authored
docs: add deprecation notice to readme (anuraghazra#4895)
Direct users to github-stats-extended, where active development has moved (see anuraghazra#4902). Collapse most existing documentation into an expandable section so the notice isn't buried, and recreate GitHub's warning callouts (which don't render inside <details>) with emoji and a border.
1 parent 5df91f9 commit 54a7985

1 file changed

Lines changed: 112 additions & 44 deletions

File tree

‎readme.md‎

Lines changed: 112 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@
3030
</a>
3131
</p>
3232

33+
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to support the original creator!</p>
34+
35+
> [!CAUTION]
36+
> **This repository is no longer maintained. Please use the successor project [GitHub Stats Extended](https://github.com/stats-organization/github-stats-extended) instead! GitHub Stats Extended is an actively maintained fork of this repository with additional features and improved stability. Alternatively you can also use [GitHub Readme Stats Action](https://github.com/stats-organization/github-readme-stats-action).**
37+
38+
<details>
39+
<summary>Click here to view the outdated documentation. Kept for reference only.</summary>
40+
41+
<br>
42+
3343
<p align="center">
3444
<a href="#all-demos">View Demo</a>
3545
·
@@ -42,9 +52,6 @@
4252
<a href="https://github.com/anuraghazra/github-readme-stats/discussions/new?category=q-a">Ask Question</a>
4353
</p>
4454

45-
46-
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!</p>
47-
4855
<details>
4956
<summary>Table of contents (Click to show)</summary>
5057

@@ -98,13 +105,17 @@
98105

99106
# Important Notices <!-- omit in toc -->
100107

101-
> [!IMPORTANT]
102-
> 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).
108+
<table><tr><td>
109+
⚠️<b>Warning</b>
110+
111+
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).
112+
</td></tr></table>
103113

104-
<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">
114+
<table><tr><td>
115+
⚠️<b>Warning</b>
105116

106-
> [!IMPORTANT]
107-
> We're a small team, and to prioritize, we rely on upvotes :+1:. We use the Top Issues dashboard for tracking community demand (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935)). Do not hesitate to upvote the issues and pull requests you are interested in. We will work on the most upvoted first.
117+
We're a small team, and to prioritize, we rely on upvotes :+1:. We use the Top Issues dashboard for tracking community demand (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935)). Do not hesitate to upvote the issues and pull requests you are interested in. We will work on the most upvoted first.
118+
</td></tr></table>
108119

109120
# GitHub Stats Card
110121

@@ -116,11 +127,18 @@ Change the `?username=` value to your GitHub username.
116127
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
117128
```
118129

119-
> [!WARNING]
120-
> 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.
130+
<table><tr><td>
131+
⚠️<b>Warning</b>
121132

122-
> [!NOTE]
123-
> 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.
133+
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.
134+
</td></tr></table>
135+
136+
137+
<table><tr><td>
138+
ℹ️<b>Note</b>
139+
140+
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.
141+
</td></tr></table>
124142

125143
### Hiding individual stats
126144

@@ -284,8 +302,11 @@ You can customize the appearance of all your cards however you wish with URL par
284302
| `locale` | Sets the language in the card, you can check full list of available locales [here](#available-locales). | enum | `en` |
285303
| `border_radius` | Corner rounding on the card. | number | `4.5` |
286304

287-
> [!WARNING]
288-
> 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.
305+
<table><tr><td>
306+
⚠️<b>Warning</b>
307+
308+
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.
309+
</td></tr></table>
289310

290311
##### Gradient in bg\_color
291312

@@ -386,11 +407,17 @@ If we don't support your language, please consider contributing! You can find mo
386407
| `show` | Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started`, `discussions_answered`, `prs_merged` or `prs_merged_percentage`). | string (comma-separated values) | `null` |
387408
| `commits_year` | Filters and counts only commits made in the specified year. | integer _(YYYY)_ | `<current year> (one year to date)` |
388409

389-
> [!WARNING]
390-
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `Anurag's GitHub Stats` should become `Anurag%27s%20GitHub%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
410+
<table><tr><td>
411+
⚠️<b>Warning</b>
391412

392-
> [!NOTE]
393-
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
413+
Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `Anurag's GitHub Stats` should become `Anurag%27s%20GitHub%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
414+
</td></tr></table>
415+
416+
<table><tr><td>
417+
ℹ️<b>Note</b>
418+
419+
When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
420+
</td></tr></table>
394421

395422
***
396423

@@ -461,17 +488,29 @@ Use `show_owner` query option to include the gist's owner username
461488

462489
The top languages card shows a GitHub user's most frequently used languages.
463490

464-
> [!WARNING]
465-
> 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.
491+
<table><tr><td>
492+
⚠️<b>Warning</b>
493+
494+
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.
495+
</td></tr></table>
466496

467-
> [!NOTE]
468-
> 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.
497+
<table><tr><td>
498+
ℹ️<b>Note</b>
469499

470-
> [!WARNING]
471-
> This card shows language usage only inside your own non-forked repositories, not depending on who the author of the commits is. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community.
500+
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.
501+
</td></tr></table>
472502

473-
> [!WARNING]
474-
> Currently this card shows data only about first 100 repositories. This is because GitHub API limitations which cause downtimes of public instances (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). In future this behavior will be improved by releasing GitHub action or providing environment variables for user's own instances.
503+
<table><tr><td>
504+
⚠️<b>Warning</b>
505+
506+
This card shows language usage only inside your own non-forked repositories, not depending on who the author of the commits is. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community.
507+
</td></tr></table>
508+
509+
<table><tr><td>
510+
⚠️<b>Warning</b>
511+
512+
Currently this card shows data only about first 100 repositories. This is because GitHub API limitations which cause downtimes of public instances (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). In future this behavior will be improved by releasing GitHub action or providing environment variables for user's own instances.
513+
</td></tr></table>
475514

476515
### Usage
477516

@@ -502,8 +541,11 @@ You can customize the appearance and behavior of the top languages card using th
502541
| `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` |
503542
| `stats_format` | Switches between two available formats for language's stats `percentages` and `bytes`. | enum | `percentages` |
504543

505-
> [!WARNING]
506-
> Language names and custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, `Most Used Languages` should become `Most%20Used%20Languages`, etc.) You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
544+
<table><tr><td>
545+
⚠️<b>Warning</b>
546+
547+
Language names and custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, `Most Used Languages` should become `Most%20Used%20Languages`, etc.) You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
548+
</td></tr></table>
507549

508550
### Language stats algorithm
509551

@@ -627,11 +669,17 @@ You can use the `&stats_format=bytes` option to display the stats in bytes inste
627669

628670
# WakaTime Stats Card
629671

630-
> [!WARNING]
631-
> Please be aware that we currently only show data from WakaTime profiles that are public. You therefore have to make sure that **BOTH** `Display code time publicly` and `Display languages, editors, os, categories publicly` are enabled.
672+
<table><tr><td>
673+
⚠️<b>Warning</b>
632674

633-
> [!WARNING]
634-
> In case you just created a new WakaTime account, then it might take up to 24 hours until your stats will become visible on the WakaTime stats card.
675+
Please be aware that we currently only show data from WakaTime profiles that are public. You therefore have to make sure that **BOTH** `Display code time publicly` and `Display languages, editors, os, categories publicly` are enabled.
676+
</td></tr></table>
677+
678+
<table><tr><td>
679+
⚠️<b>Warning</b>
680+
681+
In case you just created a new WakaTime account, then it might take up to 24 hours until your stats will become visible on the WakaTime stats card.
682+
</td></tr></table>
635683

636684
Change the `?username=` value to your [WakaTime](https://wakatime.com) username.
637685

@@ -657,8 +705,11 @@ You can customize the appearance and behavior of the WakaTime stats card using t
657705
| `display_format` | Sets the WakaTime stats display format. Choose `time` to display time-based stats or `percent` to show percentages. | enum | `time` |
658706
| `disable_animations` | Disables all animations in the card. | boolean | `false` |
659707

660-
> [!WARNING]
661-
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `WakaTime Stats` should become `WakaTime%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
708+
<table><tr><td>
709+
⚠️<b>Warning</b>
710+
711+
Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `WakaTime Stats` should become `WakaTime%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
712+
</td></tr></table>
662713

663714
### Demo
664715

@@ -866,8 +917,11 @@ Selecting the right scopes for your token is important in case you want to displ
866917

867918
#### Fine-grained token
868919

869-
> [!WARNING]\
870-
> This limits the scope to issues in your repositories and includes only public commits.
920+
<table><tr><td>
921+
⚠️<b>Warning</b>
922+
923+
This limits the scope to issues in your repositories and includes only public commits.
924+
</td></tr></table>
871925

872926
* Go to [Account -> Settings -> Developer Settings -> Personal access tokens -> Fine-grained tokens](https://github.com/settings/tokens).
873927
* Click on `Generate new token -> Generate new token`.
@@ -887,11 +941,17 @@ Selecting the right scopes for your token is important in case you want to displ
887941

888942
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started!
889943

890-
> [!NOTE]
891-
> Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:.
944+
<table><tr><td>
945+
ℹ️<b>Note</b>
946+
947+
Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:.
948+
</td></tr></table>
892949

893-
> [!NOTE]
894-
> If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage.
950+
<table><tr><td>
951+
ℹ️<b>Note</b>
952+
953+
If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage.
954+
</td></tr></table>
895955

896956
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
897957

@@ -919,8 +979,11 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
919979

920980
### On other platforms
921981

922-
> [!WARNING]
923-
> This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.
982+
<table><tr><td>
983+
⚠️<b>Warning</b>
984+
985+
This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.
986+
</td></tr></table>
924987

925988
<details>
926989
<summary><b>:hammer_and_wrench: Step-by-step guide for deploying on other platforms</b></summary>
@@ -977,8 +1040,11 @@ GitHub Readme Stats provides several environment variables that can be used to c
9771040

9781041
See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance.
9791042

980-
> [!WARNING]
981-
> Please remember to redeploy your instance after making any changes to the environment variables so that the updates take effect. The changes will not be applied to the previous deployments.
1043+
<table><tr><td>
1044+
⚠️<b>Warning</b>
1045+
1046+
Please remember to redeploy your instance after making any changes to the environment variables so that the updates take effect. The changes will not be applied to the previous deployments.
1047+
</td></tr></table>
9821048

9831049
## Keep your fork up to date
9841050

@@ -1004,3 +1070,5 @@ Thanks! :heart:
10041070
Contributions are welcome! <3
10051071

10061072
Made with :heart: and JavaScript.
1073+
1074+
</details>

0 commit comments

Comments
 (0)