update README

2026-05-13 11:38:06 +02:00
parent b3139d9c5b
commit 177d2e7e70
1 changed files with 25 additions and 1 deletions
@@ -1,4 +1,28 @@
 # bnuy-api

 A API which collects pictures of bunnies and provides a API to get random bunny pictures.
-doesn't work yet, still in progress
+
+it's just a basic API right now, I want to add more sources for gifs (tenor?) and maybe more sources for pictures
+
+# Usage
+
+The API is available [here](https://bnuy-api.scrunkly.cat/random)
+
+# Selfhosting
+
+Just copy the compose.yml from the repo and copy the .env.example to .env and fill it.
+
+```
+# bnuy-api
+POST_LIMIT=20
+LOG_LEVEL=INFO
+FORWARDED_ALLOW_IPS=172.16.0.0/12
+
+# Database MariaDB
+DB_HOST=mariadb
+DB_PORT=3306
+DB_ROOT_PASSWORD=rootpassword
+DB_USER=bnuy
+DB_PASSWORD=example
+DB_NAME=bnuy
+```