diff options
| author | mat <github@matdoes.dev> | 2023-02-05 14:31:52 -0600 |
|---|---|---|
| committer | mat <github@matdoes.dev> | 2023-02-05 14:31:52 -0600 |
| commit | 0d3a091c232d409939db82dfb30f700e57583c85 (patch) | |
| tree | 592c3734d824fb2a5cc25d07a997c98239b7d99c /azalea/src/lib.rs | |
| parent | a72b76839782b26e49598313bb04c5d322a34788 (diff) | |
| download | azalea-drasl-0d3a091c232d409939db82dfb30f700e57583c85.tar.xz | |
improve docs
Diffstat (limited to 'azalea/src/lib.rs')
| -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, |