From 51c81056053737c076a595a556b5f03349b0544f Mon Sep 17 00:00:00 2001
From: Fuwn <contact@fuwn.me>
Date: Tue, 8 Mar 2022 02:23:46 -0800
Subject: refactor: md to rst

---
 README.md     | 60 ++++++++++++++++++++++++-----------------------------------
 src/routes.rs | 38 +++++++++++++++++++++----------------
 2 files changed, 46 insertions(+), 52 deletions(-)

diff --git a/README.md b/README.md
index 1912302..7f0d8f3 100644
--- a/README.md
+++ b/README.md
@@ -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/contact@fuwn.me">
-<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/contact@fuwn.me">
+      <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>`_
diff --git a/src/routes.rs b/src/routes.rs
index e2c4e88..955dc2a 100644
--- a/src/routes.rs
+++ b/src/routes.rs
@@ -26,13 +26,14 @@ use crate::{
 
 pub fn index() -> Result<Response> {
   Response::ok(
-    r#"# senpy-club/api-worker
+    r#"senpy-club/api-worker
+=====================
 
-## routes
-if a language requires a parameter, it will be notated like ":this".
-for example; if a route is notated as "/v1/route/:parameter", you can
-access that route via the url
-"http://this.domain/v1/route/something"
+routes
+------
+if a language requires a parameter, it will be notated like ":this". for
+example; if a route is notated as "/v1/route/:parameter", you can access that
+route via the url "http://this.domain/v1/route/something".
 
 - /
   - /: index page (you are here)
@@ -40,24 +41,29 @@ access that route via the url
 - /v1
   - /github: github api mirror
   - /languages: a list of all languages that appear in _the_ repository
-  - /language/:language: get a list of all images that pertain to the language ":language"
+  - /language/:language: get a list of all images that pertain to the language
+    ":language"
 
-## notes
+notes
+-----
 
-### contributing
+contributing
+^^^^^^^^^^^^
 
 if you'd like to support the project in any way, check out the repository!
-<https://github.com/senpy-club/api>
+<https://github.com/senpy-club/api-worker>
 
-### supporting
+supporting
+^^^^^^^^^^
 
-if you would like to support my development ventures, visit my github profile here :3
-<https://github.com/fuwn>
+if you would like to support my development ventures, visit my github profile
+`here <https://github.com/fuwn>`_.
 
-### license
+license
+^^^^^^^
 
-gnu general public license v3.0 (gpl-3.0-only)
-<https://github.com/senpy-club/api-worker/blob/main/LICENSE>"#,
+`gnu general public license v3.0 (:code:`gpl-3.0-only`)
+<https://github.com/senpy-club/api-worker/blob/main/LICENSE>`_"#,
   )
 }
 
-- 
cgit v1.2.3