Ver Fonte

Update readme to match changes to example.

Bruce há 8 anos atrás
pai
commit
ba9606f415
1 ficheiros alterados com 25 adições e 18 exclusões
  1. 25 18
      examples/appmaker/README.md

+ 25 - 18
examples/appmaker/README.md

@@ -1,40 +1,47 @@
 <img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
-AppMaker Example
-====
 
-This example demonstrates how to utilize DiscordGo to create Bot Applications.
+## DiscordGo AppMaker Example
 
-You can create a new bot account, view the list of applications you have, and
-delete applications.
+This example demonstrates how to utilize DiscordGo to create, view, and delete
+Bot Applications on your account.
+
+These tasks are normally accomplished from the 
+(Discord Developers)[https://discordapp.com/developers/applications/me] site.
+
+**Join [Discord Gophers](https://discord.gg/0f1SbxBZjYoCtNPP)
+Discord chat channel for support.**
 
 ### 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.
 
+From within the appmaker example folder, run the below command to compile the
+example.
+
 ```sh
 go build
 ```
 
 ### Usage
 
+This example only uses authentication tokens for authentication. While 
+user email/password is supported by DiscordGo, it is not recommended.
+
 ```
+./appmaker --help
 Usage of ./appmaker:
-  -a string
-        App/Bot Name
   -d string
         Application ID to delete
-  -e string
-        Account Email
   -l    List Applications Only
-  -p string
-        Account Password
+  -n string
+        Name to give App/Bot
   -t string
-        Account Token
+        Owner Account Token
 ```
 
-* Account Email and Password or Token are required.  The account provided with
-these fields will be the "owner" of any bot applications created.
+* Account Token is required.  The account will be the "owner" of any bot 
+applications created.
 
 * If you provide the **-l** flag than appmaker will only display a list of 
 applications on the provided account.
@@ -42,9 +49,9 @@ applications on the provided account.
 * If you provide a **-d** flag with a valid application ID then that application
 will be deleted.
 
-Below example will create a new Bot Application under the given Email/Password 
-account. The Bot will be named **DiscordGoRocks**
+Below example will create a new Bot Application under the given account.
+The Bot will be named **DiscordGoRocks**
 
 ```sh
-./appmaker -e Email -p Password -a DiscordGoRocks
+./appmaker -t YOUR_USER_TOKEN -a DiscordGoRocks
 ```