add synopsis section

This commit is contained in:
c9s 2020-10-08 22:26:33 +08:00
parent 8f902d657e
commit 04b377258d

View File

@ -14,6 +14,41 @@ aims to release v1.0 before 11/14
- Stream integration (user data websocket)
- PnL calculation.
## Synopsis
_**still under construction**_
```go
import (
"github.com/c9s/bbgo"
)
mysqlURL := viper.GetString("mysql-url")
mysqlURL = fmt.Sprintf("%s?parseTime=true", mysqlURL)
db, err := sqlx.Connect("mysql", mysqlURL)
if err != nil {
return err
}
t := bbgo.New(bbgo.Config{
DB: db,
})
t.AddNotifier(slacknotifier.New(slackToken))
t.AddLogHook(slacklog.NewLogHook(slackToken))
t.AddExchange("binance", binance.New(viper.Getenv("bn-key"), viper.Getenv("bn-secret")))).
Subscribe("binance", "btcusdt", "kline@5m", "book", "trade").
AddStrategy(bondtrade.New, bondtrade.New).
Symbols("btcusdt", "bnbusdt")
t.AddExchange("max", max.New(viper.Getenv("max-key"), viper.Getenv("max-secret")))).
Subscribe("max", "btctwd", "kline@5m", "book", "trade").
AddStrategy(flashdrop.New, bondtrade.New)
t.AddCrossExchangeStrategy(hedgemaker.New(...))
```
## License
MIT License