Document intents for Songbird (#1061)

serenity-rs · Nov 5, 2020 · 38a55da · 38a55da
1 parent 7e4392a
commit 38a55da
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,9 @@ The library offers:
  handling, seeking on compatible streams, shared multithreaded audio stream caches,
  and direct Opus data passthrough from DCA files.
 
+## Intents
+Songbird's gateway functionality requires you to specify the `GUILD_VOICE_STATES` intent.
+
 ## Examples
 Full examples showing various types of functionality and integrations can be found as part of [serenity's examples], and in [this crate's examples directory].
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -17,6 +17,9 @@
 //!  handling, seeking on compatible streams, shared multithreaded audio stream caches,
 //!  and direct Opus data passthrough from DCA files.
 //!
+//! ## Intents
+//! Songbird's gateway functionality requires you to specify the `GUILD_VOICE_STATES` intent.
+//!
 //! ## Examples
 //! Full examples showing various types of functionality and integrations can be found as part of [serenity's examples],
 //! and in [this crate's examples directory].