From e234f8b7566bb0672361253b15e08c55b87275c7 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Mon, 31 Oct 2022 15:37:41 +0000 Subject: [PATCH] add basic installation instructions --- azalea/src/lib.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) 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