diff options
| author | Fuwn <[email protected]> | 2021-04-26 15:42:39 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-04-26 15:42:39 +0000 |
| commit | 7bd062230b43f8bd9cf2ec0f0db92704c5765f26 (patch) | |
| tree | 78545fde636ec248aa039aa2ec1581b9b9055338 /readme.md | |
| parent | fmt: Change case (diff) | |
| download | api-7bd062230b43f8bd9cf2ec0f0db92704c5765f26.tar.xz api-7bd062230b43f8bd9cf2ec0f0db92704c5765f26.zip | |
major: :star:
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..81fe664 --- /dev/null +++ b/readme.md @@ -0,0 +1,30 @@ +<p align="center"> +<h1>senpy-api</h1> +</p> + +<p align="center"> +<a href="https://discord.com/invite/yWKgRT6" title="discord"> +<img src="https://img.shields.io/discord/246524734718738442" alt="discord"> +</a> +<a href="./license" title="license"> +<img src="https://img.shields.io/github/license/Whirlsplash/whirl" alt="license"> +</a> +</p> + +## notice +nix integration is currently broken. until [rocket](https://crates.io/crates/rocket) officially +releases version `0.5.0`, it will stay broken. + +## nix +- build: `nix-build senpy-api.nix` +- docker: `nix-build default.nix` + +## usage +- run (dev): `ROCKET_ENV=dev cargo run` +- build (prod): `ROCKET_ENV=prod cargo build --release` + +## 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) |