aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoey Sacchini <joey@sacchini.net>2020-10-19 11:55:37 -0400
committerJoey Sacchini <joey@sacchini.net>2020-10-19 11:55:37 -0400
commit239a60fddab2694836f3117de429b9bf40256766 (patch)
tree007b927a3f3864639321cc988b0b0ad68f2c8662 /README.md
parenta2c1bcbf82a3ed7d76d464abab708f5472cfaa3f (diff)
downloadmcproto-rs-239a60fddab2694836f3117de429b9bf40256766.tar.gz
mcproto-rs-239a60fddab2694836f3117de429b9bf40256766.tar.bz2
mcproto-rs-239a60fddab2694836f3117de429b9bf40256766.zip
allow no_std with alloc
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 365fed9..448d35d 100644
--- a/README.md
+++ b/README.md
@@ -7,4 +7,9 @@ This crate can be used to implement any version of the minecraft protocol, and h
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
+More documentation to come, just dumping the code since I finished it.
+
+## `#![no_std]`
+
+You can use this crate without the standard library (but requiring `alloc`) by setting `default-features = false` in
+your Cargo.toml. This will only disable the `UUID4::random()` function, which requires `OsRandom` to generate a random UUID. \ No newline at end of file