diff options
| author | Joey Sacchini <joey@sacchini.net> | 2020-09-29 15:39:31 -0400 |
|---|---|---|
| committer | Joey Sacchini <joey@sacchini.net> | 2020-09-29 15:39:31 -0400 |
| commit | 2e6119a65f260f460dd67860dd5f5af7286bcb42 (patch) | |
| tree | eaa99d3f30c3b25a4138153182fef31bd0780291 | |
| parent | 5b8e64e398ce5cc3cd8067545836416485b1f7ea (diff) | |
| download | mcproto-rs-2e6119a65f260f460dd67860dd5f5af7286bcb42.tar.gz mcproto-rs-2e6119a65f260f460dd67860dd5f5af7286bcb42.tar.bz2 mcproto-rs-2e6119a65f260f460dd67860dd5f5af7286bcb42.zip | |
add readme
| -rw-r--r-- | README.md | 10 |
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 |