refactor: file case

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1912302
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+<p align="center">
+<h1>senpy-api</h1>
+</p>
+
+<p align="center">
+<a href="https://discord.com/invite/yWKgRT6">
+<img src="https://img.shields.io/discord/246524734718738442" alt="discord" />
+</a>
+<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/senpy-club/api" alt="license" />
+</a>
+</p>
+
+## nix
+- build: `nix-build`
+- docker: `nix-build docker.nix`
+
+## usage (without docker)
+- run (dev): `cargo run`
+
+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.
+
+### license
+[gnu general public license v3.0](https://github.com/senpy-club/api/blob/main/license)