From c5dee4f26edc135463b4fadf784406aa81534cab Mon Sep 17 00:00:00 2001
From: creations <creations@creations.works>
Date: Sun, 5 Jan 2025 21:50:24 -0500
Subject: [PATCH] update readme and env example, not sure why i used password
 instead of apikey

---
 .example.env |  6 +++---
 README.md    | 12 +++++++++++-
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/.example.env b/.example.env
index 2183a0b..c5ea26f 100644
--- a/.example.env
+++ b/.example.env
@@ -7,6 +7,6 @@ HOST=0.0.0.0
 REDIS_PASSWORD=pasw0rd
 
 #REQUIRED if you want to use the e621 API
-E621_USER_AGENT=YourBotName/1.0 (by username on e621)
-E621_USERNAME=username
-E621_API_KEY=apikey
+E621_USER_AGENT=YourApplication/1.0 (by username on e621)
+E621_USERNAME=your-username
+E621_API_KEY=your-apikey
diff --git a/README.md b/README.md
index 44976d1..a80d9b3 100644
--- a/README.md
+++ b/README.md
@@ -47,4 +47,14 @@
 
 ---
 
-> **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.
+> **Note**
+> To use the e621 API, you must update the following environment variables in your `.env` file:
+>
+> ```env
+> # REQUIRED if you want to use the e621 API
+> E621_USER_AGENT=YourBotName/1.0 (by username on e621)
+> E621_USERNAME=your-username
+> E621_API_KEY=your-apikey
+> ```
+>
+> Replace `your-username` and `your-apikey` with your e621 account credentials. Update the `User-Agent` string to include your application name, version, and a contact method (e.g., your e621 username) to comply with e621's API guidelines.