init

1 files changed, 20 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..6453a5e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,20 @@
+# fast_tiled
+
+Parser for the tmx format Version 1.5
+
+## Goals
+
+- fast parsing of tiled files
+- a low level (to parse single files)
+- a higher level API (point to a map and it loads all tile-maps it references, or loads an entire world from a world file and stuff like that)
+
+## The plan
+
+The idea is to first have something low level that just parses the tmx/tsx files and provides them in rust types.
+
+After that is done there could be more high level methods/struct that provide more high level functionality.
+
+Wishlist (things that would be nice):
+
+- serializing from rust types back to tmx/tsx (this needs including another xml lib, because roxmltree if fast because it is read-only)
+- parsing from and serializing back to the tiled json based formats