aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67f61df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+evtclib
+#######
+
+`evtclib` is a Rust library that allows you to parse `.evtc` files, as
+generated by the [arcdps addon](https://www.deltaconnected.com/arcdps/) for the
+Guild Wars 2 video game.
+
+It supports a low-level parsing interface and a higher-level interface which
+interprets some of the data and converts it to a more appropriate interface.
+
+`evtclib` uses `cargo` as its build tool and as such can be included as a
+dependency in other Rust projects. API docs can be generated locally by running
+`cargo doc`.
+
+License
+-------
+
+This project is licensed under the MIT license (`LICENSE` or
+https://opensource.org/licenses/MIT).