From 7c3e47e37eb338f8465fe65eba6ddec5462cb5b2 Mon Sep 17 00:00:00 2001
From: zv <zv@zvcloud.net>
Date: Sat, 18 Apr 2026 21:34:52 +0200
Subject: [PATCH] feat(mentionhelp): add README with cog functionality and
 installation instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65d8922
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# MentionHelp
+
+Cog for Red-DiscordBot that sends a help embed when someone mentions the bot directly.
+
+## What it does
+
+- Detects direct mention messages:
+  - `<@BOT_ID>`
+  - `<@!BOT_ID>`
+- Replies with an embed that tells users to run:
+  - `[prefix]help`
+- Uses bot/server locale to choose response language:
+  - `pl*` -> Polish
+  - anything else -> English
+- If locale lookup fails, it safely falls back to English.
+
+## Locale priority
+
+Locale is resolved using Red's guild-aware locale API, so server locale takes priority over global locale.  
+If no valid locale is available, English is used.
+
+## Installation
+
+1. Put this cog folder in your custom cogs path.
+2. In Discord:
+
+```text
+[p]load mentionhelp
+```
+
+## Notes
+
+- The cog only responds in guilds (not in DMs).
+- It ignores bot messages.