From 627f9a3ca683260d649305af0552f94a32aefbc0 Mon Sep 17 00:00:00 2001 From: Austin Davis Date: Tue, 4 Oct 2016 15:45:36 -0600 Subject: [PATCH] Updates docs to include the newly required "Bot" infront of bot user tokens. (#266) --- examples/airhorn/README.md | 2 +- examples/avatar/localfile/README.md | 4 ++-- examples/avatar/url/README.md | 4 ++-- examples/mytoken/README.md | 10 ++++++++-- examples/new_basic/README.md | 12 +++++++++--- examples/pingpong/README.md | 10 ++++++++-- 6 files changed, 30 insertions(+), 12 deletions(-) diff --git a/examples/airhorn/README.md b/examples/airhorn/README.md index 562e2c9..44f4d52 100644 --- a/examples/airhorn/README.md +++ b/examples/airhorn/README.md @@ -27,7 +27,7 @@ Usage of ./airhorn: The below example shows how to start the bot. ```sh -./airhorn -t +./airhorn -t "Bot YOUR_BOT_TOKEN" ``` ### Creating sounds diff --git a/examples/avatar/localfile/README.md b/examples/avatar/localfile/README.md index 9a39e0a..cf15472 100644 --- a/examples/avatar/localfile/README.md +++ b/examples/avatar/localfile/README.md @@ -37,5 +37,5 @@ Usage of ./ocalfile: For example to start application with Token and a non-default avatar: ```sh -./localfile -t "YOUR_BOT_TOKEN" -f "./pathtoavatar.jpg" -``` \ No newline at end of file +./localfile -t "Bot YOUR_BOT_TOKEN" -f "./pathtoavatar.jpg" +``` diff --git a/examples/avatar/url/README.md b/examples/avatar/url/README.md index 6247f00..340fd68 100644 --- a/examples/avatar/url/README.md +++ b/examples/avatar/url/README.md @@ -37,5 +37,5 @@ Usage of ./url: For example to start application with Token and a non-default avatar: ```sh -./url -t "YOUR_BOT_TOKEN" -l "http://bwmarrin.github.io/discordgo/img/discordgo.png" -``` \ No newline at end of file +./url -t "Bot YOUR_BOT_TOKEN" -l "http://bwmarrin.github.io/discordgo/img/discordgo.png" +``` diff --git a/examples/mytoken/README.md b/examples/mytoken/README.md index 4450873..a870615 100644 --- a/examples/mytoken/README.md +++ b/examples/mytoken/README.md @@ -2,12 +2,12 @@ MyToken Example ==== -This example demonstrates how to utilize DiscordGo to print out the +This example demonstrates how to utilize DiscordGo to print out the Authentication Token for a given user account. ### Build -This assumes you already have a working Go environment setup and that +This assumes you already have a working Go environment setup and that DiscordGo is correctly installed on your system. ```sh @@ -33,3 +33,9 @@ authentication. ```sh ./mytoken -e EmailHere -p PasswordHere ``` + +The below example shows how to start the bot using the bot user's token + +```sh +./pingpong -t "Bot YOUR_BOT_TOKEN" +``` diff --git a/examples/new_basic/README.md b/examples/new_basic/README.md index d45523e..c5557ff 100644 --- a/examples/new_basic/README.md +++ b/examples/new_basic/README.md @@ -2,14 +2,14 @@ Basic New Example ==== -This example demonstrates how to utilize DiscordGo to connect to Discord +This example demonstrates how to utilize DiscordGo to connect to Discord and print out all received chat messages. This example uses the high level New() helper function to connect to Discord. ### Build -This assumes you already have a working Go environment setup and that +This assumes you already have a working Go environment setup and that DiscordGo is correctly installed on your system. ```sh @@ -18,7 +18,7 @@ go build ### Usage -You must authenticate using either an Authentication Token or both Email and +You must authenticate using either an Authentication Token or both Email and Password for an account. Keep in mind official Bot accounts only support authenticating via Token. @@ -39,3 +39,9 @@ authentication. ```sh ./new_basic -e EmailHere -p PasswordHere ``` + +The below example shows how to start the bot using the bot user's token + +```sh +./new_basic -t "Bot YOUR_BOT_TOKEN" +``` diff --git a/examples/pingpong/README.md b/examples/pingpong/README.md index 267d4ad..0eb43eb 100644 --- a/examples/pingpong/README.md +++ b/examples/pingpong/README.md @@ -8,7 +8,7 @@ This Bot will respond to "ping" with "Pong!" and "pong" with "Ping!". ### Build -This assumes you already have a working Go environment setup and that +This assumes you already have a working Go environment setup and that DiscordGo is correctly installed on your system. ```sh @@ -17,7 +17,7 @@ go build ### Usage -You must authenticate using either an Authentication Token or both Email and +You must authenticate using either an Authentication Token or both Email and Password for an account. Keep in mind official Bot accounts only support authenticating via Token. @@ -38,3 +38,9 @@ authentication. ```sh ./pingpong -e EmailHere -p PasswordHere ``` + +The below example shows how to start the bot using the bot user's token + +```sh +./pingpong -t "BOT YOUR_BOT_TOKEN" +```