mindustry logic execution, map- and schematic- parsing and rendering
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index f08c5b1..9aa8287 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,20 @@
# mindus
-- see the [mindus](mindus/) folder for schematic and map rendering and deserializing
-- see the [lemu](lemu/) folder for mlog execution \ No newline at end of file
+![msrv](https://img.shields.io/badge/msrv-nightly-blue?style=for-the-badge&logo=rust)
+
+Mindus is a library for working with [Mindustry](https://github.com/Anuken/Mindustry) formats.
+
+## Usage
+
+```rs
+use mindus::*;
+let reg = build_registry();
+let mut ss = SchematicSerializer(&reg);
+let s = ss.deserialize_base64("bXNjaAF4nD3SQW6DMBBA0bE94wF104vkDr1H1QVtWUQioTL0/oFJ/Fl9GXiy5ZFBhiJ6n26zvE9tv7T1f5/bZbtNyyJvv/P2065/+3W9i0hdpu952SR/fiWp29qOL4/lDzkfExkiEpWPGqMKpZRRlT/8VQkv4aXwnlUopYw6vRTVvRzeGJVYy1ShlDKqezk8O8+DV/AKXgkvRSllvK2sdU/xFE/xFE/xFE/xNLzxeRlU9wzPOK9xXsMzPMOr3EcNL0VlqlBKGVWpfh+O5+zPmRdnXpx5cebFmRd/eQ9KIReL")?;
+let output = s.render();
+output.save("output.png");
+```
+
+This produces:
+
+![image](https://raw.githubusercontent.com/bend-n/mindus/master/.github/example.png)