mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-17 15:09:59 +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.
61 lines
1.6 KiB
Cheetah
61 lines
1.6 KiB
Cheetah
{{define "communications telegram" -}}
|
|
{{template "header" .}}
|
|
## Telegram Communications package
|
|
|
|
### What is telegram?
|
|
|
|
+ Telegram is a cloud-based instant messaging and voice over IP service
|
|
developed by Telegram Messenger LLP
|
|
+ Please visit: [Telegram](https://telegram.org/) for more information
|
|
|
|
### Current Features
|
|
|
|
+ Creation of bot that can retrieve
|
|
- Bot status
|
|
- ANX orderbook
|
|
- ANX ticker
|
|
|
|
### 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/telegram"
|
|
"github.com/thrasher-/gocryptotrader/config"
|
|
)
|
|
|
|
t := new(telegram.Telegram)
|
|
|
|
// Define Telegram configuration
|
|
commsConfig := config.CommunicationsConfig{TelegramConfig: config.TelegramConfig{
|
|
Name: "Telegram",
|
|
Enabled: true,
|
|
Verbose: false,
|
|
VerificationToken: "token",
|
|
}}
|
|
|
|
t.Setup(commsConfig)
|
|
err := t.Connect
|
|
// Handle error
|
|
```
|
|
|
|
+ Once the bot has started you can interact with the bot using these commands
|
|
via Telegram:
|
|
|
|
```
|
|
/start - Will authenticate your ID
|
|
/status - Displays the status of the bot
|
|
/help - Displays current command list
|
|
/settings - Displays current bot settings
|
|
/ticker - Displays current ANX ticker data
|
|
/portfolio - Displays your current portfolio
|
|
/orderbooks - Displays current orderbooks for ANX`
|
|
```
|
|
|
|
### Please click GoDocs chevron above to view current GoDoc information for this package
|
|
{{template "contributions"}}
|
|
{{template "donations"}}
|
|
{{end}}
|