From eaa1d434a04de3ff7798c4c61eeb4c82946d99af Mon Sep 17 00:00:00 2001
From: Freya Murphy <freya@freyacat.org>
Date: Thu, 14 Dec 2023 19:50:39 -0500
Subject: docs

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1220ca9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+### nbtvis
+
+Command line visualizer for the minecraft [NBT](https://wiki.vg/NBT) data file format.
+
+#### usage
+
+`nbtvis <file.nbt>`
+
+You can know if a file is NBT if the first byte in hexdump is `0a`
+
+#### complementation
+
+To build and install run
+
+```
+make build
+sudo make install
+```
+
+The binary will be installed to `/usr/lcoal/bin/nbtvis`
+
+#### license
+
+This project is licensed under the [MIT](https://mit-license.org/) license
-- 
cgit v1.2.3-freya