diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 24 insertions, 36 deletions
@@ -1,38 +1,26 @@ -<p align="center"> -<h1>senpy-api</h1> -</p> +:code:`api-worker` +================== -<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> +.. raw:: html + <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-worker"> + <img src="https://www.codefactor.io/repository/github/senpy-club/api-worker/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-worker" + 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) +license +^^^^^^^ +`gnu general public license v3.0 <https://github.com/senpy-club/api-worker/blob/main/LICENSE>`_ |