diff --git a/README.md b/README.md index 0f295ae..c02da77 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ async fn main() { "wss://example.com/".to_string(), "https://example.com/cdn".to_string(), ); - let instance = Instance::new(bundle, true) + let instance = Instance::new(bundle) .await .expect("Failed to connect to the Spacebar server"); // You can create as many instances of `Instance` as you want, but each `Instance` should likely be unique. diff --git a/src/instance.rs b/src/instance.rs index cd9eb76..f151ced 100644 --- a/src/instance.rs +++ b/src/instance.rs @@ -72,7 +72,7 @@ impl PartialEq for LimitsInformation { } impl Instance { - /// Creates a new [`Instance`] from the [relevant instance urls](UrlBundle), where `limited` is whether Chorus will track and enforce rate limits for this instance. + /// Creates a new [`Instance`] from the [relevant instance urls](UrlBundle). To create an Instance from one singular url, use [`Instance::from_root_url()`]. pub async fn new(urls: UrlBundle) -> ChorusResult { let is_limited: Option = Instance::is_limited(&urls.api).await?; let limit_information; diff --git a/src/lib.rs b/src/lib.rs index 80374fb..0bddc3a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,7 +19,7 @@ async fn main() { "wss://example.com/".to_string(), "https://example.com/cdn".to_string(), ); - let instance = Instance::new(bundle, true) + let instance = Instance::new(bundle) .await .expect("Failed to connect to the Spacebar server"); // You can create as many instances of `Instance` as you want, but each `Instance` should likely be unique.