diff options
| author | Fuwn <[email protected]> | 2022-03-09 01:43:56 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2022-03-09 01:43:56 -0800 |
| commit | db920aae2a29b1f1e20b6e3998ee62c9e7cca9be (patch) | |
| tree | aa7d7f65f2ff73eead404f345e7c4bc72b7c163f /src/index.rst | |
| parent | refactor(utils): String to char (diff) | |
| download | api-worker-db920aae2a29b1f1e20b6e3998ee62c9e7cca9be.tar.xz api-worker-db920aae2a29b1f1e20b6e3998ee62c9e7cca9be.zip | |
refactor(routes): get index from file
Diffstat (limited to 'src/index.rst')
| -rw-r--r-- | src/index.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/src/index.rst b/src/index.rst new file mode 100644 index 0000000..0b96cf1 --- /dev/null +++ b/src/index.rst @@ -0,0 +1,35 @@ +api.senpy.club +============== + +Routes +------ + +If a language requires a parameter, it will be notated like ":this". + +For example; if a route is notated as "/v2/route/:parameter", you can access that route via the URL "https://api.senpy.club/v2/route/parameter-value". + +- / + - /: Index page, a mirror of /v2 (you are here) + +- /v2 + - /github: GitHub API mirror for https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books + - /languages: A list of all languages that appear in the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository + - /language/:language: A list of all images that are labeled under the language, ":language", in the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository + +Notes +----- + +Contributing +^^^^^^^^^^^^ + +If you'd like to support the project in any way, check out the repository: https://github.com/senpy-club/api-worker + +Supporting +^^^^^^^^^^ + +If you would like to support my development ventures, visit my GitHub profile: https://github.com/Fuwn + +License +^^^^^^^ + +`GNU General Public License v3.0 <https://github.com/senpy-club/api-worker/blob/main/LICENSE>`_ |