chore: add README.md

noctisynth · Oct 28, 2024 · 7845fa8 · 7845fa8
1 parent 4278658
commit 7845fa8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.cspell.json b/.cspell.json
@@ -2,6 +2,7 @@
     "words": [
         "covector",
         "lalrpop",
-        "noctisroll"
+        "noctisroll",
+        "TRPG"
     ]
 }
diff --git a/README.md 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")?;
+```