diff options
Diffstat (limited to 'azalea-protocol')
| -rw-r--r-- | azalea-protocol/README.md | 6 | ||||
| -rw-r--r-- | azalea-protocol/src/lib.rs | 12 |
2 files changed, 5 insertions, 13 deletions
diff --git a/azalea-protocol/README.md b/azalea-protocol/README.md index 8c41daa1..1cadc3b4 100644 --- a/azalea-protocol/README.md +++ b/azalea-protocol/README.md @@ -1,5 +1,7 @@ -# Azalea Protocol +# `azalea-protocol` -A low-level crate to send and receive Minecraft packets. If you intend on making bots, you should use the main `azalea` crate instead. +A low-level crate for sending and receiving Minecraft packets. Only the latest Minecraft version is supported. + +See [`crate::connect::Connection`] for usage. diff --git a/azalea-protocol/src/lib.rs b/azalea-protocol/src/lib.rs index 803f8630..dfff7da7 100644 --- a/azalea-protocol/src/lib.rs +++ b/azalea-protocol/src/lib.rs @@ -1,14 +1,4 @@ -//! A low-level crate to send and receive Minecraft packets. -//! -//! You should probably use [`azalea`] or [`azalea_client`] instead, as -//! `azalea_protocol` delegates much of the work, such as auth, to the user of -//! the crate. -//! -//! [`azalea`]: https://crates.io/crates/azalea -//! [`azalea_client`]: https://crates.io/crates/azalea-client -//! -//! See [`crate::connect::Connection`] for an example. - +#![doc = include_str!("../README.md")] // this is necessary for thiserror backtraces #![feature(error_generic_member_access)] |