From bdef1cccdd14aa6b4ea97aeb3f1c886955756199 Mon Sep 17 00:00:00 2001 From: Alexandr Garbuzov Date: Tue, 6 Jun 2023 18:26:15 +0300 Subject: [PATCH] Add note about private contributions into readme (#2776) * Add note about private contributions into readme * dev --- readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/readme.md b/readme.md index bb7f7a9..94e6a8a 100644 --- a/readme.md +++ b/readme.md @@ -110,6 +110,9 @@ Change the `?username=` value to your GitHub username. [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ``` +> **Warning** +> By default stats card shows contributions only from public repositories. To show your private contributions you should [deploy you own instance](#deploy-on-your-own) using your own GitHub API token which allowed to see your private data. + > **Note** > Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories. The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js).