about summary refs log tree commit diff
diff options
context:
space:
mode:
authorNakidai <plaza521@inbox.ru>2024-09-04 19:41:37 +0300
committerNakidai <plaza521@inbox.ru>2024-09-04 19:41:37 +0300
commit1b494bb088ef5ded22eec090dd50161ea564cc63 (patch)
treed0ecc1980c5beb03a0debe1f541523143e538322
parent5ae48feb9cc03241a5c6b2578a357db5736ba359 (diff)
downloadpetthecord-1b494bb088ef5ded22eec090dd50161ea564cc63.tar.gz
petthecord-1b494bb088ef5ded22eec090dd50161ea564cc63.zip
Add Setup section to the README.md
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7755fa4..6d2cc0e 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@ PetTheCord
 --
 This is a Web API for petting any user you know which has avatar
 
+## Setup
+Create some discord application (it is needed for getting discord user's avatar)
+and put its token to `PETTHECORD_TOKEN` env var or write it to file and create
+`PETTHECORD_TOKEN_FILE` env var with the path of the file with the token. Other
+help is desribed in the `--help`.
+
 ## Usage
 `https://example.com/<UserID>.gif` will return you gif that specified user.