diff --git a/README.rst b/README.rst index 3e10467..edb56c0 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=: + export APIKEY_GITLAB=: + +Generation of personal access tokens are explained on `GitHub documentation `_ and `GitLab documentation `_. +No scopes have to be selected, being authenticated is enough to get higher rate limit. + Contributing ------------