From d9ff09da6bb6e502b53f0cd3e04c4dc1535d02ac Mon Sep 17 00:00:00 2001 From: jake Date: Wed, 4 Jun 2025 17:08:50 -0400 Subject: [PATCH] readme update --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9482b49..3e764b5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Base Discord bot framework bolt is a wrapper for Discordgo to provide very quick and easy setup for simple Discord bots. The only code required to run bolt is the command handler functions, this provides developers with the ability to have text-based commands on a Discord server without all the bootstrapping and setup usually required. Any strings returned from the Payload function will be sent back to the Discord server as a reply to the command message. ## Basic Usage -bolt allows developers to create a Discord bot with simply a discord bot token and a few lines of Go code, the below example creates a Discord bot and registers three commands: ".test", ".time", and ".role" +bolt allows developers to create a Discord bot with simply a discord bot token and a few lines of Go code, the below example creates a Discord bot and registers three commands: ".ping", ".time", and ".role" ```go package main @@ -25,14 +25,14 @@ func main() { b := bolt.New() b.AddCommands( - // .test can be run at any time by anyone + // .ping can be run at any time by anyone and will respond with 'pong' bolt.Command{ - Trigger: ".test", + Trigger: ".ping", Payload: func(msg bolt.Message) (res string, err error) { - return "nah", nil //any strings returned will be sent in response to the Discord message + return "pong", nil //any strings returned will be sent in response to the Discord message }, }, - // .time can be run every 25 seconds by anyone + // .time can be run every 25 seconds by anyone and will respond with 'yer' bolt.Command{ Trigger: ".time", Payload: func(msg bolt.Message) (res string, err error) { @@ -40,7 +40,7 @@ func main() { }, Timeout: time.Second * 25, }, - // .role can be run every 10 seconds by anyone with the 'admin' role + // .role can be run every 10 seconds by anyone with the 'admin' role and will respond with 'hi' bolt.Command{ Trigger: ".role", Payload: func(msg bolt.Message) (res string, err error) {