pothtonswer/discordmuffin
1
0
Fork 1
Code Issues 2 Pull requests 1 Projects 2 Releases Packages Wiki Activity Actions

Clean up readme.

Browse source
This commit is contained in:
Bruce 2017-04-10 16:27:22 +00:00
parent 98779bc3b9
commit 8b67603145
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
examples/pingpong/README.md
View file

@ -1,24 +1,31 @@
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
PingPong Example
====
# DiscordGo Ping Pong Example
This example demonstrates how to utilize DiscordGo to create a Ping Pong Bot.
This Bot will respond to "ping" with "Pong!" and "pong" with "Ping!".
**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
DiscordGo is correctly installed on your system.
From within the pingpong example folder, run the below command to compile the
example.
```sh
go build
```
### Usage
This example uses bot tokens for authentication only.
While user/password is supported by DiscordGo, it is not recommended.
This example uses bot tokens for authentication only. While user/password is
supported by DiscordGo, it is not recommended for bots.
```
./pingpong --help
@ -31,4 +38,5 @@ The below example shows how to start the bot
```sh
./pingpong -t YOUR_BOT_TOKEN
Bot is now running. Press CTRL-C to exit.
```