From 2f01890f2e7d9206f92ac30077a832bb86e2b393 Mon Sep 17 00:00:00 2001
From: skuzow <alex@skuzow.net>
Date: Sun, 3 Jul 2022 00:25:40 +0200
Subject: [PATCH] docs: complete readme

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index 5d66a85..03aa647 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,32 @@
 Simple [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) offline whitelist helper plugin.
 
 More plugins in [MCDReforgedPluginsCatalogue](https://github.com/MCDReforged/PluginCatalogue/blob/catalogue/readme.md).
+
+## 🗿 Commands
+
+- `!!offw` Display help message
+- `!!offw add <username>` Add player to whitelist
+- `!!offw remove <username>` Remove player from whitelist
+- `!!offw list` Show players inside whitelist
+- `!!offw reload` Reload plugin itself
+
+## 💾 Config
+
+Location: `config/offline_whitelist.json`
+
+```json
+{
+    "whitelist_path": "./server/whitelist.json",
+    "minimum_permission_level": 2 // helper
+}
+```
+
+## 🗂️ Required Python libraries
+
+- [mcdreforged](https://github.com/Fallen-Breath/MCDReforged) >= 1.2.0
+
+To install them execute:
+
+```bash
+  pip install -r requirements.txt
+```