aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..365fed9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# mcproto-rs
+
+This is an implementation of serialization and deserialization of the minecraft protocol.
+
+This crate can be used to implement any version of the minecraft protocol, and has an example implementation of version
+1.15.2 included as module `v1_15_2`.
+
+To implement your own protocol, consult this example, and use the macros to define a protocol to your heart's content!
+
+More documentation to come, just dumping the code since I finished it. \ No newline at end of file