Clean up readme.

This commit is contained in:
Bruce 2017-04-10 16:27:22 +00:00
parent 98779bc3b9
commit 8b67603145

View file

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