From 43a641a68c35f80a9ac60902e23073043a986733 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Mon, 26 Apr 2021 16:41:15 -0700 Subject: repository(README): Make note of PAT --- readme.md | 4 ++++ 1 file changed, 4 insertions(+) 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. -- cgit v1.2.3