Merge branch 'main' of https://github.com/senpy-club/api into main

2 files changed, 11 insertions, 1 deletions

diff --git a/readme.md b/readme.md
index a60d874..396ffdd 100644
--- a/readme.md
+++ b/readme.md
@@ -9,6 +9,9 @@
 <a href="https://www.codefactor.io/repository/github/senpy-club/api">
 <img src="https://www.codefactor.io/repository/github/senpy-club/api/badge" alt="codefactor" />
 </a>
+<a href="https://saythanks.io/to/[email protected]">
+<img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanks" />
+</a>
 <a href="./license">
 <img src="https://img.shields.io/github/license/Whirlsplash/whirl" alt="license" />
 </a>
@@ -26,6 +29,13 @@ 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
+very much present.
+
+if you 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.
 
diff --git a/src/routes.rs b/src/routes.rs
index 7f47a9a..d7512b4 100644
--- a/src/routes.rs
+++ b/src/routes.rs
@@ -41,7 +41,7 @@ https://github.com/fuwn
 
 ### license
 gnu general public license v3.0 (gpl-3.0-only)
-https://github.com/senpy-club/api/blob/main/LICENSE"#
+https://github.com/senpy-club/api/blob/main/license"#
 }
 
 #[get("/github")]