From c272a213422fa1147bdc4c06b487f4add0600072 Mon Sep 17 00:00:00 2001
From: anuraghazra <hazru.anurag@gmail.com>
Date: Mon, 13 Jul 2020 19:50:43 +0530
Subject: [PATCH] docs: added rank docs

---
 readme.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/readme.md b/readme.md
index 0e02eaf3..008ba778 100644
--- a/readme.md
+++ b/readme.md
@@ -40,6 +40,8 @@ change the `?username=` value to your GitHubs'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 users stats, see [src/calculateRank.js](./src/calculateRank.js)_
+
 ### Hiding individual stats
 
 To hide any specific stats, you can pass a query parameter `?hide=` with an array of items, you wanna hide.
@@ -62,6 +64,7 @@ Other options:
 
 - `&hide_border=true` hide the border box if you don't like it :D.
 - `&line_height=30` control the line-height between text.
+- `&hide_rank=true` hides the ranking
 
 ### Customization