From 8b6760314539857242d7596cca02ea49ee8b86b3 Mon Sep 17 00:00:00 2001 From: Bruce Date: Mon, 10 Apr 2017 16:27:22 +0000 Subject: [PATCH] Clean up readme. --- examples/pingpong/README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/examples/pingpong/README.md b/examples/pingpong/README.md index d2ad61f..d15c20d 100644 --- a/examples/pingpong/README.md +++ b/examples/pingpong/README.md @@ -1,24 +1,31 @@ -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. ```