Skip to content

Commit

Permalink
Remove deprecated login_bot function from docs
Browse files Browse the repository at this point in the history
`Client::login_bot` is now deprecated.

Users should instead use `Client::login`.
  • Loading branch information
hsiW authored and zeyla committed May 17, 2017
1 parent b468cbf commit ae395f4
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Expand Up @@ -8,8 +8,7 @@ Serenity is a Rust library for the Discord API.

View the [examples] on how to make and structure a bot.

Serenity supports both bot and user login via the use of [`Client::login_bot`]
and [`Client::login_user`].
Serenity supports bot login via the use of [`Client::login`].

You may also check your tokens prior to login via the use of
[`validate_token`].
Expand Down Expand Up @@ -47,7 +46,7 @@ use std::env;
fn main() {
// Login with a bot token from the environment
let mut client = Client::login_bot(&env::var("DISCORD_TOKEN").expect("token"));
let mut client = Client::login(&env::var("DISCORD_TOKEN").expect("token"));
client.with_framework(|f| f
.configure(|c| c.prefix("~")) // set the bot's prefix to "~"
.on("ping", ping));
Expand Down Expand Up @@ -136,8 +135,7 @@ Voice+youtube-dl:
- [discordrb][rel:discordrb] (Ruby)

[`Cache`]: https://serenity.zey.moe/serenity/ext/cache/struct.Cache.html
[`Client::login_bot`]: https://serenity.zey.moe/serenity/client/struct.Client.html#method.login_bot
[`Client::login_user`]: https://serenity.zey.moe/serenity/client/struct.Client.html#method.login_user
[`Client::login`]: https://serenity.zey.moe/serenity/client/struct.Client.html#method.login
[`Client::on_message`]: https://serenity.zey.moe/serenity/client/struct.Client.html#method.on_message
[`Shard`]: https://serenity.zey.moe/serenity/client/gateway/struct.Shard.html
[`Context`]: https://serenity.zey.moe/serenity/client/struct.Context.html
Expand Down

0 comments on commit ae395f4

Please sign in to comment.