aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUbuntu <github@matdoes.dev>2022-10-31 15:37:41 +0000
committerUbuntu <github@matdoes.dev>2022-10-31 15:37:41 +0000
commite234f8b7566bb0672361253b15e08c55b87275c7 (patch)
tree42714ba2c3e3991ec34e240996ddd0ed59876d69
parentaea53cd380f9e2b294ee88bccba73171df48f7da (diff)
downloadazalea-drasl-e234f8b7566bb0672361253b15e08c55b87275c7.tar.xz
add basic installation instructions
-rw-r--r--azalea/src/lib.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/azalea/src/lib.rs b/azalea/src/lib.rs
index 636981f3..4a042b79 100644
--- a/azalea/src/lib.rs
+++ b/azalea/src/lib.rs
@@ -5,6 +5,17 @@
//! refer to `azalea_client`. You can just replace these with `azalea` in your
//! code, since everything from azalea_client is re-exported in azalea.
//!
+//! # Installation
+//!
+//! First, install Rust nightly with `rustup install nightly` and `rustup
+//! default nightly`.
+//!
+//! Then, add one of the following lines to your Cargo.toml.\
+//! Latest bleeding-edge version:
+//! `azalea = { git="https://github.com/mat-1/Cargo.toml" }`
+//! Latest "stable" release:
+//! `azalea = "0.3"`
+//!
//! # Examples
//!
//! ```rust,no_run