From 7845fa8bcb10fd2621bfa7cc30f0ccd895bbbbc0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=8B=8F=E5=90=91=E5=A4=9C?= <fu050409@163.com>
Date: Mon, 28 Oct 2024 20:50:13 +0800
Subject: [PATCH] chore: add `README.md`

---
 .cspell.json |  3 ++-
 README.md    | 11 +++++++++++
 2 files changed, 13 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.cspell.json b/.cspell.json
index 1ad5340..7a9880a 100644
--- a/.cspell.json
+++ b/.cspell.json
@@ -2,6 +2,7 @@
     "words": [
         "covector",
         "lalrpop",
-        "noctisroll"
+        "noctisroll",
+        "TRPG"
     ]
 }
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ada350
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Noctisroll
+
+A Text-based TRPG dice rolling system.
+
+## Usage
+
+```rust
+use noctisroll::roll_dice;
+
+let result = roll_dice("1d20+3")?;
+```