summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9b84ccc..beebd6e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# mew
-Hex code editor in Rust
+# mew 0.2 - Hex code editor in Rust
+
+> [!CAUTION]
+> The current version of this program is unstable, has bugs and is not ready for use.
+
+### Installation
+```shell
+git chone https://github.com/Ad4ndi/mew
+cd mew
+cargo build
+```
+
+### Usage
+```shell
+mew [file]
+```
+
+### Bugs (TODO)
+
+- No line scrolling
+- ASCII block alignment issue
+- Unoptimized file loading (full)