From 38a55da88bb61d862fa471e2d7b9a222c230f1cb Mon Sep 17 00:00:00 2001
From: Kyle Simpson <kyleandrew.simpson@gmail.com>
Date: Thu, 5 Nov 2020 23:25:29 +0000
Subject: [PATCH] Document intents for Songbird (#1061)

---
 README.md  | 3 +++
 src/lib.rs | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 72d271b9d..9fff975a5 100644
--- 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
index 99e53c70f..b01ecc152 100644
--- 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].