From 0d3a091c232d409939db82dfb30f700e57583c85 Mon Sep 17 00:00:00 2001
From: mat <github@matdoes.dev>
Date: Sun, 5 Feb 2023 14:31:52 -0600
Subject: improve docs

---
 azalea/src/lib.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'azalea/src')

diff --git a/azalea/src/lib.rs b/azalea/src/lib.rs
index 026a35f5..b7707b92 100644
--- a/azalea/src/lib.rs
+++ b/azalea/src/lib.rs
@@ -39,6 +39,15 @@ pub enum StartError {
     Join(#[from] azalea_client::JoinError),
 }
 
+/// A builder for creating new [`Client`]s. This is the recommended way of
+/// making Azalea bots.
+///
+/// ```no_run
+/// azalea::ClientBuilder::new()
+///     .set_handler(handle)
+///     .start(Account::offline("bot"), "localhost")
+///     .await;
+/// ```
 pub struct ClientBuilder<S, Fut>
 where
     S: Default + Send + Sync + Clone + 'static,
-- 
cgit v1.2.3