From 7584e8e16caea4ffbed11eb6a283ccc7d5b38334 Mon Sep 17 00:00:00 2001
From: snow flurry <snow@datagirl.xyz>
Date: Sun, 16 Jun 2024 18:25:25 -0700
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4f78179
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# One-Click Unsubscribe for KMail
+
+This is an initial attempt to provide support for [RFC 8058](https://www.rfc-editor.org/rfc/rfc8058.html) One-Click Unsubscribe to KMail.
+
+This is still a work in progress, but appears to work. Sadly, One-Click Unsubscribe is difficult to meaningfully test.
+
+## Requirements
+
+This was built using Qt6 and the following KDE Frameworks:
+
+- extra-cmake-modules
+- KConfig
+- KCoreAddons
+- KGuiAddons
+- KXmlGui
+- KParts
+- KIO
+
+Additionally, the following KDE PIM libraries are required:
+
+- Libkdepim
+- PimCommon
+- Messagelib
+
+## Building
+
+This plugin is built using CMake.
+
+```
+$ cmake -Bbuild .
+$ cmake --build build
+$ cmake --install build
+```
+
+## Usage
+
+Once installed, the Unsubscribe button can be added to the KMail Toolbar by right clicking it and selecting "Configure Toolbars...".