mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-22 23:16:48 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
54 lines
1.3 KiB
Cheetah
54 lines
1.3 KiB
Cheetah
{{define "communications slack" -}}
|
|
{{template "header" .}}
|
|
## Slack Communications package
|
|
|
|
### What is Slack?
|
|
|
|
+ Slack is a code-centric collaboration hub that allows users to connect via an
|
|
app and share different types of data
|
|
+ Please visit: [Slack](https://slack.com/) for more information and account setup
|
|
|
|
### Current Features
|
|
|
|
+ Basic communication to your slack channel information includes:
|
|
- Working status of bot
|
|
|
|
### How to enable
|
|
|
|
+ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-communications-via-config-example)
|
|
|
|
+ Individual package example below:
|
|
```go
|
|
import (
|
|
"github.com/thrasher-corp/gocryptotrader/communications/slack"
|
|
"github.com/thrasher-corp/gocryptotrader/config"
|
|
)
|
|
|
|
s := new(slack.Slack)
|
|
|
|
// Define slack configuration
|
|
commsConfig := config.CommunicationsConfig{SlackConfig: config.SlackConfig{
|
|
Name: "Slack",
|
|
Enabled: true,
|
|
Verbose: false,
|
|
TargetChannel: "targetChan",
|
|
VerificationToken: "slackGeneratedToken",
|
|
}}
|
|
|
|
s.Setup(commsConfig)
|
|
err := s.Connect
|
|
// Handle error
|
|
```
|
|
|
|
Once the bot has started you can interact with the bot using these commands
|
|
via Slack:
|
|
|
|
```
|
|
!status - Displays current working status of bot
|
|
!help - Displays help text
|
|
!settings - Displays current settings
|
|
```
|
|
|
|
{{template "donations" .}}
|
|
{{end}}
|