Added README to example
This commit is contained in:
parent
fba35f09fe
commit
b9edc87709
1 changed files with 41 additions and 0 deletions
41
examples/new_basic/README.md
Normal file
41
examples/new_basic/README.md
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
|
||||||
|
Basic New Example
|
||||||
|
====
|
||||||
|
|
||||||
|
This example demonstrates how to utilize DiscordGo to connect to Discord
|
||||||
|
and print out all received chat messages.
|
||||||
|
|
||||||
|
This example uses the high level New() helper function to connect to Discord.
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
This assumes you already have a working Go environment setup and that
|
||||||
|
DiscordGo is correctly installed on your system.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
You must authenticate using either an Authentication Token or both Email and
|
||||||
|
Password for an account. Keep in mind official Bot accounts only support
|
||||||
|
authenticating via Token.
|
||||||
|
|
||||||
|
```
|
||||||
|
./new_basic --help
|
||||||
|
Usage of ./new_basic:
|
||||||
|
-e string
|
||||||
|
Account Email
|
||||||
|
-p string
|
||||||
|
Account Password
|
||||||
|
-t string
|
||||||
|
Account Token
|
||||||
|
```
|
||||||
|
|
||||||
|
The below example shows how to start the bot using an Email and Password for
|
||||||
|
authentication.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
./new_basic -e EmailHere -p PasswordHere
|
||||||
|
```
|
Loading…
Reference in a new issue