aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index a60d874..c06451c 100644
--- a/readme.md
+++ b/readme.md
@@ -26,6 +26,10 @@ releases version `0.5.0`, it will stay broken.
- run (dev): `ROCKET_ENV=dev cargo run`
- build (prod): `ROCKET_ENV=prod cargo build --release`
+also note that this api wrapper leverages the official github api, meaning that rate-limits are
+going to be self hosting this project, it is highly encouraged that you generate yourself a github
+personal access token and set the environment variable `GITHUB_TOKEN` as your pat.
+
## contributing
please reference the [contribution guidelines](./contributing.md) of this repository.