From d404d5ab5a1cc7b0cc8a4545d83273929fc64010 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <stefan.verhoeven@gmail.com>
Date: Tue, 9 Mar 2021 11:37:07 +0100
Subject: [PATCH 1/3] Describe why apikey is needed, where to get them and the
 format.

Fixes #319
Fixes #93 completely
---
 README.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.rst b/README.rst
index 3e10467..9134dc2 100644
--- a/README.rst
+++ b/README.rst
@@ -319,6 +319,23 @@ The manual override will be reflected in the output, as follows:
     (5/5) checklist
           ✓ skipped (reason: I'm using the Codacy dashboard to guide my development)
 
+Rate limit
+^^^^^^^^^^
+
+By default ``howfairis`` uses anonymous requests to the API of the source code platforms.
+However when a lot of repositories are checked you will exceed the rate limit of those APIs and checks will fail.
+To increase the rate limit you need to use authenticated requests.
+Your username and token can be passed to ``howfairis`` using environment variables called ``APIKEY_GITHUB`` and ``APIKEY_GITLAB``.
+The format of the environment variable values are:
+
+.. code-block:: shell
+
+  export APIKEY_GITHUB=<user who made the token>:<personal access token>
+  export APIKEY_GITLAB=<user who made the token>:<personal access token>
+
+Your personal access token should be created on `GitHub <https://github.com/settings/tokens>`_ and `GitLab <https://gitlab.com/-/profile/personal_access_tokens>`_ settings pages.
+No scopes have to be selected, being authenticated is enough to get higher rate limit.
+
 Contributing
 ------------
 

From b29c85ca46d6b956c485aee2bf0c795384bae430 Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <s.verhoeven@esciencecenter.nl>
Date: Tue, 9 Mar 2021 12:05:32 +0100
Subject: [PATCH 2/3] Update README.rst

Co-authored-by: Faruk D. <fdiblen@users.noreply.github.com>
---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 9134dc2..33fc189 100644
--- a/README.rst
+++ b/README.rst
@@ -333,7 +333,7 @@ The format of the environment variable values are:
   export APIKEY_GITHUB=<user who made the token>:<personal access token>
   export APIKEY_GITLAB=<user who made the token>:<personal access token>
 
-Your personal access token should be created on `GitHub <https://github.com/settings/tokens>`_ and `GitLab <https://gitlab.com/-/profile/personal_access_tokens>`_ settings pages.
+Generation of personal access tokens are explained on `GitHub documentation <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>`_ and `GitLab documentation <https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token>`_ .
 No scopes have to be selected, being authenticated is enough to get higher rate limit.
 
 Contributing

From bf0c23fd3c12f3aeb3e120425acf568ff045debd Mon Sep 17 00:00:00 2001
From: Stefan Verhoeven <s.verhoeven@esciencecenter.nl>
Date: Tue, 9 Mar 2021 12:06:34 +0100
Subject: [PATCH 3/3] Update README.rst

Co-authored-by: Faruk D. <fdiblen@users.noreply.github.com>
---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 33fc189..edb56c0 100644
--- a/README.rst
+++ b/README.rst
@@ -333,7 +333,7 @@ The format of the environment variable values are:
   export APIKEY_GITHUB=<user who made the token>:<personal access token>
   export APIKEY_GITLAB=<user who made the token>:<personal access token>
 
-Generation of personal access tokens are explained on `GitHub documentation <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>`_ and `GitLab documentation <https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token>`_ .
+Generation of personal access tokens are explained on `GitHub documentation <https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token>`_ and `GitLab documentation <https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token>`_.
 No scopes have to be selected, being authenticated is enough to get higher rate limit.
 
 Contributing