creations/booru-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme and env example, not sure why i used password instead of apikey

Browse source
This commit is contained in:
creations 2025-01-05 21:50:24 -05:00
parent 1b0e8054f4
commit c5dee4f26e
Signed by: creations
GPG key ID: 8F553AA4320FC711
2 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.example.env
View file

@ -7,6 +7,6 @@ HOST=0.0.0.0
REDIS_PASSWORD=pasw0rd REDIS_PASSWORD=pasw0rd
#REQUIRED if you want to use the e621 API #REQUIRED if you want to use the e621 API
E621_USER_AGENT=YourBotName/1.0 (by username on e621) E621_USER_AGENT=YourApplication/1.0 (by username on e621)
E621_USERNAME=username E621_USERNAME=your-username
E621_API_KEY=apikey E621_API_KEY=your-apikey

12
README.md
View file

@ -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.