From 9925be5e0b2dbae7bcd2079b1967b2db5972bcf4 Mon Sep 17 00:00:00 2001
From: PhatPhuckDave <david.majdandzic@hotmail.com>
Date: Fri, 27 Dec 2024 15:39:18 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab73dad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Dechickenator
+
+## Overview
+Dechickenator is a World of Warcraft addon that automatically manages unwanted buffs with custom messaging.
+
+## Versions
+- **v1 (Master)**: Simple buff removal with predefined actions
+- **v2.0**: More complex alert system with customizable actions
+
+## Features
+- Automatically remove unwanted buffs
+- Send custom emote messages when buffs are applied
+- Perform "spit" emote on buff source
+
+## Installation
+1. Extract the addon to your World of Warcraft `Interface/AddOns` directory
+2. Ensure the addon is enabled in the character selection screen
+
+## Usage
+
+### Toggling Blacklisted Buffs
+Use `/dechicken BuffName` to add or remove a buff from the blacklist.
+
+### Customizing Message
+Use `/dechicken_message Your custom message with %s for source name`
+
+### Examples
+```
+# Toggle "Greater Blessing of Kings" blacklist
+/dechicken Greater Blessing of Kings
+
+# Set a custom message
+/dechicken_message %s thinks they're special!
+```
+
+## Default Behavior
+- When a blacklisted buff is applied, it will be automatically removed
+- An emote message will be sent (default: "Индивидуум %s хочет поделиться своим истинным обликом")
+- A "spit" emote will be performed towards the buff source
\ No newline at end of file