discordmuffin/examples/autocomplete/README.md
Fedor Lapshin 4ba7062176
Add README.md to all examples (#1236)
* feat(examples/*): add readme

Add README.md to all examples.

* fix(examples): logo image link

* fix(examples): add fixed width to logo

* feat(examples): add titles

* fix(examples/*): make logo smaller

Make DiscordGo logo smaller to match description and title in size.

* fix(examples/avatar): correct avatar url

Use correct logo URL in avatar URL image example.

* fix(examples/slash_commands): wording

Fix wording of "step-by-step tutorial" note.
2022-11-09 22:19:23 +03:00

41 lines
1.1 KiB
Markdown

<img align="right" alt="DiscordGo logo" src="/docs/img/discordgo.svg" width="200">
## DiscordGo Slash Command Autocomplete Option Example
This example demonstrates how to utilize DiscordGo to create and use
autocomplete options in Slash Commands. As this example uses interactions,
slash commands and slash command options, it is recommended to read
`slash_commands` example before proceeding.
**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 autocomplete example folder, run the below command to compile the
example.
```sh
go build
```
### Usage
```
Usage of autocomplete:
-guild string
Test guild ID. If not passed - bot registers commands globally
-rmcmd
Whether to remove all commands after shutting down (default true)
-token string
Bot access token
```
The below example shows how to start the bot from the autocomplete example folder.
```sh
./autocomplete -guild YOUR_TESTING_GUILD -token YOUR_BOT_TOKEN
```