aboutsummaryrefslogtreecommitdiff
path: root/azalea-client/src/account.rs
diff options
context:
space:
mode:
authormat <github@matdoes.dev>2022-10-30 15:28:19 -0500
committermat <github@matdoes.dev>2022-10-30 15:28:19 -0500
commit329f8b1784b26e2149f6edb4e969e10bd419a190 (patch)
tree89c641aa1c26bb8da9e1f23337ff3114ad52b8f2 /azalea-client/src/account.rs
parentc65e1fc6604baf308b8c2b20b94bf527a6721ade (diff)
downloadazalea-drasl-329f8b1784b26e2149f6edb4e969e10bd419a190.tar.xz
more docs
Diffstat (limited to 'azalea-client/src/account.rs')
-rw-r--r--azalea-client/src/account.rs12
1 files changed, 12 insertions, 0 deletions
diff --git a/azalea-client/src/account.rs b/azalea-client/src/account.rs
index 715f2fba..2fedc4f5 100644
--- a/azalea-client/src/account.rs
+++ b/azalea-client/src/account.rs
@@ -6,6 +6,18 @@ use uuid::Uuid;
/// Something that can join Minecraft servers.
///
/// To join a server using this account, use [`crate::Client::join`].
+///
+/// # Examples
+///
+/// ```rust,no_run
+/// use azalea_client::Account;
+///
+/// # #[tokio::main]
+/// # async fn main() {
+/// let account = Account::microsoft("example@example.com").await;
+/// // or Account::offline("example");
+/// # }
+/// ```
#[derive(Clone, Debug)]
pub struct Account {
/// The Minecraft username of the account.