From 747b1bee174bbff7a8557fb05c5925e3fa5bce23 Mon Sep 17 00:00:00 2001
From: Aiden Fuller <49333050+AidenFuller@users.noreply.github.com>
Date: Fri, 11 Apr 2025 21:11:50 +1000
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0091791
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+A plugin for JetBrains IDEs that automatically prefixes commit messages with information extracted from branch names. 
+
+Features:
+- Extract information from branch names using configurable regex patterns
+- Format commit messages using configurable format patterns
+- Enable/disable the plugin from the commit dialog
+
+The branch name extraction pattern is configurable from the IDE settings
+
+Example:
+- Branch name: `feature/12345-add-new-feature`
+- Commit message: `Initial implementation`
+- Result: `#12345 - Initial implementation`