From aa459db435670cbc4121e82660a33d83d45431e6 Mon Sep 17 00:00:00 2001
From: thibaud-leclere <thibaud.leclere@lundimatin.fr>
Date: Fri, 10 Apr 2026 12:40:46 +0200
Subject: [PATCH] docs: add usage and verify build

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9905a3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# email-mcp
+
+`email-mcp` is a local Go CLI for configuring one IMAP account in KDE Wallet and exposing read-only mailbox access over MCP.
+
+## Requirements
+
+- Linux
+- A D-Bus session with KDE Wallet available
+- Go 1.25 or newer
+- IMAP account credentials
+
+## Commands
+
+- `email-mcp setup` to store IMAP credentials
+- `email-mcp mcp` to start the MCP stdio server
+
+If you build the binary locally from this repo, run it as `./email-mcp` from the project root.
+
+## Build and Test
+
+```bash
+go test ./...
+go build ./cmd/email-mcp
+```