summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d01899
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# MikuSays 🎤
+
+A `cowsay` clone with Hatsune Miku ASCII art and speech bubbles.
+
+## Usage
+
+```bash
+mikusays "Hello, World!"
+```
+
+## Installation
+
+Download from [Releases](https://github.com/YOUR_USERNAME/mikusays/releases):
+
+- **Windows**: `mikusays-windows-*.exe`
+- **Linux**: `mikusays-linux-*`
+- **macOS**: `mikusays-macos-*`
+
+Or build from source:
+```bash
+cargo build --release
+```
+
+## Development
+
+```bash
+cargo build
+cargo run -- "message"
+``` \ No newline at end of file