migan/discordmuffin
1
0
Fork 0
forked from pothtonswer/discordmuffin
Code Pull requests Activity

Update readme to match changes to example.

Browse source
This commit is contained in:
Bruce 2017-04-10 21:06:43 +00:00
parent d1c23ecb09
commit ba9606f415
1 changed files with 25 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
examples/appmaker/README.md
View file

@ -1,40 +1,47 @@
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png"> <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 This example demonstrates how to utilize DiscordGo to create, view, and delete
delete applications. 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 ### 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. DiscordGo is correctly installed on your system.
From within the appmaker example folder, run the below command to compile the
example.
```sh ```sh
go build go build
``` ```
### Usage ### 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: Usage of ./appmaker:
-a string
App/Bot Name
-d string -d string
Application ID to delete Application ID to delete
-e string
Account Email
-l List Applications Only -l List Applications Only
-p string -n string
Account Password Name to give App/Bot
-t string -t string
Account Token Owner Account Token
``` ```
* Account Email and Password or Token are required. The account provided with * Account Token is required. The account will be the "owner" of any bot
these fields will be the "owner" of any bot applications created. applications created.
* If you provide the **-l** flag than appmaker will only display a list of * If you provide the **-l** flag than appmaker will only display a list of
applications on the provided account. 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 * If you provide a **-d** flag with a valid application ID then that application
will be deleted. will be deleted.
Below example will create a new Bot Application under the given Email/Password Below example will create a new Bot Application under the given account.
account. The Bot will be named **DiscordGoRocks** The Bot will be named **DiscordGoRocks**
```sh ```sh
./appmaker -e Email -p Password -a DiscordGoRocks ./appmaker -t YOUR_USER_TOKEN -a DiscordGoRocks
``` ```