From 1ab25bd4f67dcb09fccc711099f7e8e73adcedcb Mon Sep 17 00:00:00 2001
From: creations <creations@creations.works>
Date: Sun, 5 Jan 2025 20:52:22 -0500
Subject: [PATCH] update readme
---
README.md | 31 +++++++++++++++++++++----------
1 file changed, 21 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 9191d2e..89bcbc9 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,28 @@
# booru-api
-# default config/secrets.ts file
+## Setup Instructions
-```ts
-const redisConfig: RedisConfig = {
- host: "127.0.0.1",
- port: 6379,
-};
+1. Rename the example environment file to `.env`:
+ ```bash
+ mv .example.env .env
+ ```
+2. Start the application in detached mode:
+ ```bash
+ docker compose up -d
+ ```
+
+---
+
+## Default `config/secrets.ts` File
+
+```typescript
const e621Auth: Record<string, string> = {
- "User-Agent": "domain/1.0 (by username on e621)",
- Authorization: "Basic " + btoa("username:password"),
+ "User-Agent": "your-domain/1.0 (by your-username on e621)",
+ Authorization: "Basic " + btoa("your-username:your-password"),
};
-export { e621Auth, redisConfig };
-```
\ No newline at end of file
+export { e621Auth };
+```
+
+> **Note**: Replace `your-username` and `your-password` with your e621 account credentials. Update the `User-Agent` string to include your domain and comply with e621's API guidelines.