Categorygithub.com/botopolis/bothelp
package
0.5.0
Repository: https://github.com/botopolis/bot.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
4
Dependents
0
Files
85 SLOC

# README

botopolis/help

GoDoc Build Status Test Coverage

Output about your botopolis commands.

Usage

See example_test.go for usage details.

In order to show what commands your plugin implements, simply implement the help.Provider interface (Help() []help.Text). help.Plugin lists the help text for all installed plugins.

Example output

user: @bot help
bot:
  help - Displays all the help commands that this bot knows about.
  help <query> - Displays all help commands that match <query>.

# Functions

New creates a new instance of the help plugin.

# Structs

Plugin is the help Plugin for botopolis/bot.
Text
Text is a representation of what is returned to the user.

# Interfaces

Provider is the interface a Plugin is expected to implement in order to provide help text.