docs: add explanation of the ranks (#576)

This commit is contained in:
Oliver Kopp 2020-10-17 15:19:42 +02:00 committed by GitHub
parent 1b1e019abc
commit 24ba102e10
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -73,7 +73,9 @@ Change the `?username=` value to your GitHub's username.
[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
```
_Note: Ranks are calculated based on user's stats, see [src/calculateRank.js](./src/calculateRank.js)_
_Note: Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone).
The values are caluclated 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 is can be investigated at [src/calculateRank.js](./src/calculateRank.js)_
### Hiding individual stats