Преглед на файлове

Updates docs to include the newly required "Bot" infront of bot user tokens. (#266)

Austin Davis преди 8 години
родител
ревизия
627f9a3ca6
променени са 6 файла, в които са добавени 30 реда и са изтрити 12 реда
  1. 1 1
      examples/airhorn/README.md
  2. 2 2
      examples/avatar/localfile/README.md
  3. 2 2
      examples/avatar/url/README.md
  4. 8 2
      examples/mytoken/README.md
  5. 9 3
      examples/new_basic/README.md
  6. 8 2
      examples/pingpong/README.md

+ 1 - 1
examples/airhorn/README.md

@@ -27,7 +27,7 @@ Usage of ./airhorn:
 The below example shows how to start the bot.
 
 ```sh
-./airhorn -t <bot token>
+./airhorn -t "Bot YOUR_BOT_TOKEN"
 ```
 
 ### Creating sounds

+ 2 - 2
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"
-```
+./localfile -t "Bot YOUR_BOT_TOKEN" -f "./pathtoavatar.jpg"
+```

+ 2 - 2
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"
-```
+./url -t "Bot YOUR_BOT_TOKEN" -l "http://bwmarrin.github.io/discordgo/img/discordgo.png"
+```

+ 8 - 2
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"
+```

+ 9 - 3
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"
+```

+ 8 - 2
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"
+```