aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2017-01-08 08:48:39 -0800
committerAustin Hellyer <[email protected]>2017-01-08 08:48:39 -0800
commitfb1daeba773a1e77b620acaf1b66893db4b20ab9 (patch)
treec7c22521cc5a0e89766edd0afa786ff87303c7ff /src
parentCode style cleanup (diff)
downloadserenity-fb1daeba773a1e77b620acaf1b66893db4b20ab9.tar.xz
serenity-fb1daeba773a1e77b620acaf1b66893db4b20ab9.zip
Remove cruft from src/lib.rs
This should clean up the docs homepage a bit.
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs57
1 files changed, 0 insertions, 57 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 2a0e976..72e9257 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -5,9 +5,6 @@
//! Serenity supports both bot and user login via the use of [`Client::login_bot`]
//! and [`Client::login_user`].
//!
-//! You may also check your tokens prior to login via the use of
-//! [`validate_token`].
-//!
//! Once logged in, you may add handlers to your client to dispatch [`Event`]s,
//! such as [`Client::on_message`]. This will cause your handler to be called
//! when a [`Event::MessageCreate`] is received. Each handler is given a
@@ -75,58 +72,6 @@
//! #[macro_use] extern crate serenity;
//! ```
//!
-//! Serenity only supports the _latest_ Stable, Beta, and Nightly.
-//!
-//! # Features
-//!
-//! Features can be enabled or disabled by configuring the library through
-//! Cargo.toml:
-//!
-//! ```toml
-//! [dependencies.serenity]
-//! git = "https://github.com/zeyla/serenity.git"
-//! default-features = false
-//! features = ["pick", "your", "feature", "names", "here"]
-//! ```
-//!
-//! The following is a full list of features:
-//!
-//! - **cache**: The cache will store information about guilds, channels, users,
-//! and other data, to avoid performing REST requests. If you are low on RAM, do
-//! not enable this;
-//! - **framework**: Enables the framework, which is a utility to allow simple
-//! command parsing, before/after command execution, prefix setting, and more;
-//! - **methods**: Enables compilation of extra methods on struct
-//! implementations, such as `Message::delete()`, `Message::reply()`,
-//! `Guild::edit()`, and more. Without this enabled, requests will need to go
-//! through the [`Context`] or [`rest`] module, which are slightly less
-//! efficient from a development standpoint, and do not automatically perform
-//! permission checking;
-//! - **voice**: Enables compilation of voice support, so that voice channels
-//! can be connected to and audio can be sent/received.
-//!
-//! # Dependencies
-//!
-//! Serenity requires the following dependencies:
-//!
-//! - openssl
-//!
-//! ### Voice
-//!
-//! The following dependencies all require the **voice** feature to be enabled
-//! in your Cargo.toml:
-//!
-//! - libsodium (Arch: `community/libsodium`)
-//! - opus (Arch: `extra/opus`)
-//!
-//! Voice+ffmpeg:
-//!
-//! - ffmpeg (Arch: `extra/ffmpeg`)
-//!
-//! Voice+youtube-dl:
-//!
-//! - youtube-dl (Arch: `community/youtube-dl`)
-//!
//! [`Cache`]: ext/cache/struct.Cache.html
//! [`Client::login_bot`]: client/struct.Client.html#method.login_bot
//! [`Client::login_user`]: client/struct.Client.html#method.login_user
@@ -136,8 +81,6 @@
//! [`Event::MessageCreate`]: model/event/enum.Event.html#variant.MessageCreate
//! [`Shard`]: client/struct.Shard.html
//! [`examples`]: https://github.com/zeyla/serenity.git/blob/master/examples
-//! [`rest`]: client/rest/index.html
-//! [`validate_token`]: client/fn.validate_token.html
//! [cache docs]: ext/cache/index.html
//! [client's module-level documentation]: client/index.html
//! [docs]: https://discordapp.com/developers/docs/intro