mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-20 23:16:49 +00:00
3b8591bcc8
* Updated documentation tool Added templates Updated documentation using tool * Fixed incorrect version in web README * Added new templates to tool. Updated documents in templates across the code base. Used tool to regenerate documentation.
46 lines
1.1 KiB
Cheetah
46 lines
1.1 KiB
Cheetah
{{define "communications smsglobal" -}}
|
|
{{template "header" .}}
|
|
## SMSGlobal Communications package
|
|
|
|
### What is SMSGlobal?
|
|
|
|
+ SMSGlobal allows bulk sending of messages via their API
|
|
+ Please visit: [SMSGlobal](https://www.smsglobal.com/) for more information and account setup
|
|
|
|
### Current Features
|
|
|
|
+ Sending of events to a list of recipients
|
|
|
|
### How to enable
|
|
|
|
+ [Enable via configuration](https://github.com/thrasher-/gocryptotrader/tree/master/config#enable-communications-via-config-example)
|
|
|
|
+ Individual package example below:
|
|
```go
|
|
import (
|
|
"github.com/thrasher-/gocryptotrader/communications/smsglobal"
|
|
"github.com/thrasher-/gocryptotrader/config"
|
|
)
|
|
|
|
s := new(smsglobal.SMSGlobal)
|
|
|
|
// Define SMSGlobal configuration
|
|
commsConfig := config.CommunicationsConfig{SMSGlobalConfig: config.SMSGlobalConfig{
|
|
Name: "SMSGlobal",
|
|
Enabled: true,
|
|
Verbose: false,
|
|
Username: "username",
|
|
Password: "password",
|
|
Contacts: []config.SMSContact{}
|
|
}}
|
|
|
|
s.Setup(commsConfig)
|
|
err := s.Connect
|
|
// Handle error
|
|
```
|
|
|
|
### Please click GoDocs chevron above to view current GoDoc information for this package
|
|
{{template "contributions"}}
|
|
{{template "donations"}}
|
|
{{end}}
|