From f9834b675606070d6584d22083c31bd9c8decda1 Mon Sep 17 00:00:00 2001
From: Warren Lo <warren@accusys.com.tw>
Date: Wed, 18 Mar 2026 21:32:53 +0800
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..323cd75
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# md_reader
+
+A simple Markdown reader with Mermaid diagram support.
+
+## Features
+
+- Render Markdown to HTML
+- Batch convert Markdown files
+- HTTP server for serving files
+- **Mermaid diagram support** with SVG export
+- Preview in browser
+
+## Installation
+
+```bash
+cargo build --release
+```
+
+## Usage
+
+### Render a single file
+
+```bash
+md_reader render document.md -o output.html
+```
+
+### Batch convert
+
+```bash
+md_reader batch ./docs/ -o ./html/
+```
+
+### Start HTTP server
+
+```bash
+md_reader server -p 8080 -d ./docs/
+```
+
+### Preview in browser
+
+```bash
+md_reader preview document.md
+```
+
+## Mermaid Support
+
+md_reader supports rendering Mermaid diagrams in Markdown files.
+
+### Usage
+
+Use `mermaid` code blocks:
+
+````markdown
+```mermaid
+graph TD
+    A[Start] --> B[End]
+```
+````
+
+### Supported Diagram Types
+
+- Flowchart
+- Sequence Diagram
+- Class Diagram
+- State Diagram
+- Gantt Chart
+- Pie Chart
+- Entity Relationship Diagram
+
+### SVG Export
+
+Hover over any Mermaid diagram and click "Download SVG" to download the vector graphic.
+
+## License
+
+MIT