Add README

Cargo.toml

@@ -3,6 +3,11 @@ name = "zztff"
 version = "0.1.0"
 edition = "2024"
 license = "MIT"
+description = "Library for reading/writing ZZT worlds and boards"
+repository = "https://github.com/cmounce/zztff"
+readme = "README.md"
+keywords = ["zzt", "encoder", "decoder", "gamedev"]
+categories = ["parser-implementations", "encoding"]
 
 [dependencies]
 codepage-437 = "0.1"

README.md

@@ -0,0 +1,7 @@
+# zztff: A Rust library for ZZT's file formats
+This crate is meant to be a flexible, somewhat low-level library for reading and writing ZZT 3.2's binary file formats.
+
+The code was originally based on the binary parser I wrote for [Marzipan](https://github.com/cmounce/marzipan), a WIP macro language for generating ZZT files.
+I extracted it from Marzipan so I could use it in a different ZZT utility, then extracted it again into this crate for easier reuse.
+So over time, the code has received a fair amount of real-world testing.
+But the crate *itself* is brand new, so it might have some rough edges; if you use it, let me know if you experience any issues!