From a8f8f3f8dd6e44e550f255b6a0d872c5355dc3b7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Szostak?=
 <104312276+theKapcioszek@users.noreply.github.com>
Date: Wed, 3 Apr 2024 19:37:42 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1b136c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# fremen-transcriptor
+
+Sofware to transcript ASCII into desert people's writing from popular sci-fi franchise.
+
+## Quick start:
+
+```console
+./make
+./fremen <your text>
+```
+
+## TODO:
+- [ ] Add text box instead of passing an argument
+- [ ] WebAssembly compilation 
+- [ ] Option to save result as an image