From 5a6f219c55bc1647f86880b405963d3c15c90432 Mon Sep 17 00:00:00 2001
From: Mestima <mestima@nilored.ru>
Date: Tue, 28 Mar 2023 18:34:40 +0300
Subject: [PATCH] Create README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fca1269
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# ~Luna discord bot
+
+### Environment
+
+NodeJS version: `v18.15.0 lts`
+
+Create and edit `.env` file, remove useless comments in production:
+
+```
+# bot token
+TOKEN=token
+# might be online, idle, invisible or dnd
+STATUS=idle
+# any string to use it as a status content
+STATUS_CONTENT=hello world
+# might be NONE, PLAYING, WATCHING, LISTENING, STREAMING, COMPETING or CUSTOM
+STATUS_TYPE=LISTENING
+# client app id
+CLIENT_ID=000000000000000000
+# development guild id
+DEV_GUILD_ID=000000000000000000
+```
+
+### Scripts
+
+- `yarn start` | run bot in a production mode
+- `yarn dev` | run bot in a dev mode