mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-06-02 07:26:53 +00:00
Basic documentation update for engine branch (#369)
* Add basic docs for gRPC/gctcli/unified API and a few markdown fixes * Update patherinos and spacing fixes * Consistent namerinos * Fix spelling mistakes * Add fancy headers * Uperaterinos * Fix feedback nitterinos
This commit is contained in:
@@ -54,19 +54,26 @@ We are aiming to support the top 20 highest volume exchanges based off the [Coin
|
||||
|
||||
## Current Features
|
||||
|
||||
+ Support for all Exchange fiat and digital currencies, with the ability to individually toggle them on/off.
|
||||
+ Support for all exchange fiat and digital currencies, with the ability to individually toggle them on/off.
|
||||
+ AES256 encrypted config file.
|
||||
+ REST API support for all exchanges.
|
||||
+ Websocket support for applicable exchanges.
|
||||
+ Ability to turn off/on certain exchanges.
|
||||
+ Ability to adjust manual polling timer for exchanges.
|
||||
+ Communication packages (Slack, SMS via SMSGlobal, Telegram and SMTP)
|
||||
+ HTTP rate limiter package.
|
||||
+ Unified API for exchange usage.
|
||||
+ Customisation of HTTP client features including setting a proxy, user agent and adjusting transport settings.
|
||||
+ NTP client package.
|
||||
+ Database support (Postgres and SQLite3). See [database](/database/README.md).
|
||||
+ OTP generation tool. See [gen otp](/cmd/gen_otp).
|
||||
+ Connection monitor package.
|
||||
+ gRPC service and JSON RPC proxy. See [gRPC service](/gctrpc/README.md).
|
||||
+ gRPC client. See [gctcli](/cmd/gctcli/README.md).
|
||||
+ Forex currency converter packages (CurrencyConverterAPI, CurrencyLayer, Fixer.io, OpenExchangeRates)
|
||||
+ Packages for handling currency pairs, tickers and orderbooks.
|
||||
+ Portfolio management tool; fetches balances from supported exchanges and allows for custom address tracking.
|
||||
+ Basic event trigger system.
|
||||
+ WebGUI.
|
||||
+ WebGUI (discontinued).
|
||||
|
||||
## Planned Features
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
|
||||
### A very special thank you to all who have contributed to this program:
|
||||
|
||||
|User|Github|Contribution Amount|
|
||||
|--|--|--|
|
||||
|User|Contribution Amount|
|
||||
|--|--|
|
||||
{{- range $contributor := .Contributors -}}
|
||||
| {{$contributor.Login}} | {{$contributor.URL}} | {{$contributor.Contributions}} |
|
||||
| [{{$contributor.Login}}]({{$contributor.URL}}) | {{$contributor.Contributions}} |
|
||||
{{end}}
|
||||
{{end}}
|
||||
|
||||
38
cmd/gctcli/README.md
Normal file
38
cmd/gctcli/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# GoCryptoTrader gRPC client
|
||||
|
||||
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
||||
|
||||
[](https://travis-ci.com/thrasher-corp/gocryptotrader)
|
||||
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
||||
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader)
|
||||
[](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
|
||||
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
||||
|
||||
A cryptocurrency trading bot supporting multiple exchanges written in Golang.
|
||||
|
||||
**Please note that this bot is under development and is not ready for production!**
|
||||
|
||||
## Community
|
||||
|
||||
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
|
||||
|
||||
## Background
|
||||
|
||||
GoCryptoTrader utilises gRPC for client/server interaction. Authentication is done
|
||||
by a self signed TLS cert, which only supports connections from localhost and also
|
||||
through basic authorisation specified by the users config file.
|
||||
|
||||
## Usage
|
||||
|
||||
GoCryptoTrader must be running with gRPC enabled in order to use the client features.
|
||||
|
||||
```bash
|
||||
go build or go run .
|
||||
```
|
||||
|
||||
For a full list of commands, you can run `gctcli --help`. Alternatively, you can also
|
||||
visit our [GoCryptoTrader API reference.](https://api.gocryptotrader.app/)
|
||||
|
||||
## Autocomplete
|
||||
|
||||
Bash/ZSH autocomplete entries can be found [here](/contrib).
|
||||
Reference in New Issue
Block a user