diff options
Diffstat (limited to 'azalea/src')
| -rw-r--r-- | azalea/src/lib.rs | 9 |
1 files changed, 9 insertions, 0 deletions
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, |