diff --git a/assets/img/integration-login.png b/assets/img/integration-login.png new file mode 100644 index 00000000..eedd4f64 Binary files /dev/null and b/assets/img/integration-login.png differ diff --git a/doc/API.md b/doc/API.md index dd3ef5b1..e0a2b1d2 100644 --- a/doc/API.md +++ b/doc/API.md @@ -41,8 +41,9 @@ over the REST API. ### User Client The third option to connect to Discord within Pharo is by using a user -account, email and password. Notice that using such account to connect -bots is strictly prohibited. +account, email and password. **Notice that using such account to connect +bots is strictly prohibited. You should not use your user account to +automate login and other operations!** ## Examples @@ -50,6 +51,6 @@ Examples are divided into three sections: - [Webhook](Webhook.md) - [Bot](Bot.md) -- [User Client](UserClient.md) Note: this documentation is missing. You can find examples on `DSClient` class side. +- User Client Note: this documentation is missing. You can find examples on `DSClient` class side. For more examples, please, check the class sides of the corresponding classes. We use [GT-Examples](https://github.com/feenkcom/gtoolkit-examples) to document the source code. diff --git a/doc/PharoIntegration.md b/doc/PharoIntegration.md index 69374171..fd70b78e 100644 --- a/doc/PharoIntegration.md +++ b/doc/PharoIntegration.md @@ -2,6 +2,12 @@ This section describes how the DiscordSt is integrated with developer tools in order to bring better electronic communication experience to Pharo developers. Notice, that the current version is focused on sending messages with a rich contents. +## Login + +The first time you use the DiscordSt integration, you need to login. To do so, open the DiscordSt send message dialog and in the account part, fill-in your Discord account email and password. If you use Two-Factor-Authentication, provide a code when requested. + +![Login](../assets/img/integration-login.png) + ## Ask Developers from GT-Playground If you have a code snippet in GT-Playground and you get stuck with it, ask directly from the playground. Click on the Discord icon. In the *Send Message Dialog*, you can write a question and choose a best channel to ask. In addition, you can add screenshots and source code in order to help the readers to understand your problem and play with it.