Skip to content

Commit 2543703

Browse files
committed
Adding to README instructions for creating and loading a GitHub token
1 parent fa9bcb5 commit 2543703

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ Please refer to the Documentation for additional use-cases and introductory info
3737
- [https://kulkansecurity.github.io/gitxray/](https://kulkansecurity.github.io/gitxray/)
3838
- [https://www.gitxray.com/](https://www.gitxray.com/)
3939

40+
# Rate Limits and the GitHub API
41+
42+
Gitxray gracefully handles Rate Limits and can work out of the box without a GitHub API key, but you'll likely hit RateLimits pretty fast (A small to medium-size repository with 10+ Contributors could take hours to complete while it waits for RateLimits to reset) This is detailed by GitHub in their [documentation here](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-unauthenticated-users).
43+
44+
[Creating a simple read-only token scoped to PUBLIC repositories](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) will however help you increase those restrictions considerably. If you're not in a hurry or can leave gitxray running you'll be able to use its full capacity, as it pauses execution while waiting for the limits to lift.
45+
46+
You may then load the token safely by using (prevents the token from being displayed on screen or getting logged in your shell history):
47+
48+
```bash
49+
read -rs GH_ACCESS_TOKEN
50+
export
51+
```
52+
4053
# Installing, Updating, and running Gitxray
4154

4255
gitxray was written with no use of external package dependencies other than the `requests` library.

0 commit comments

Comments
 (0)