From b46bce66c42c7996cca94515e50ae4acbe42e1ae Mon Sep 17 00:00:00 2001 From: Bruce Marriner Date: Fri, 22 Apr 2016 12:57:55 -0500 Subject: [PATCH] Added README to api_basic --- examples/api_basic/README.md | 41 ++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 examples/api_basic/README.md diff --git a/examples/api_basic/README.md b/examples/api_basic/README.md new file mode 100644 index 0000000..e7baf51 --- /dev/null +++ b/examples/api_basic/README.md @@ -0,0 +1,41 @@ + +Basic API Example +==== + +This example demonstrates how to utilize DiscordGo to connect to Discord +and print out all received chat messages. + +This example uses the low-level REST API functions 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. + +``` +./api_basic --help +Usage of ./pingpong: + -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 +./api_basic -e EmailHere -p PasswordHere +```