lychiyu/bbgo_origin
1
0
Fork 0
mirror of https://github.com/c9s/bbgo.git synced 2024-11-14 02:53:50 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

grammatical errors in the README.md

Browse Source
This commit is contained in:
Himanshu Kumar Mahto 2023-11-01 02:20:58 +05:30 committed by GitHub
parent 7c1060c208
commit 64cad56727
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -101,25 +101,25 @@ the implementation.
| xnav | this strategy helps you record the current net asset value | tool | no | | xnav | this strategy helps you record the current net asset value | tool | no |
| xalign | this strategy aligns your balance position automatically | tool | no | | xalign | this strategy aligns your balance position automatically | tool | no |
| xfunding | a funding rate fee strategy | funding | no | | xfunding | a funding rate fee strategy | funding | no |
| autoborrow | this strategy uses margin to borrow assets, to help you keep the minimal balance | tool | no | | autoborrow | this strategy uses margin to borrow assets, to help you keep a minimal balance | tool | no |
| pivotshort | this strategy finds the pivot low and entry the trade when the price breaks the previous low | long/short | | | pivotshort | this strategy finds the pivot low and enters the trade when the price breaks the previous low | long/short | |
| schedule | this strategy buy/sell with a fixed quantity periodically, you can use this as a single DCA, or to refill the fee asset like BNB. | tool | | schedule | this strategy buy/sell with a fixed quantity periodically, you can use this as a single DCA, or to refill the fee asset like BNB. | tool |
| irr | this strategy opens the position based on the predicated return rate | long/short | | | irr | this strategy opens the position based on the predicated return rate | long/short | |
| bollmaker | this strategy holds a long-term long/short position, places maker orders on both side, uses bollinger band to control the position size | maker | | | bollmaker | this strategy holds a long-term long/short position, places maker orders on both sides, and uses a bollinger band to control the position size | maker | |
| wall | this strategy creates wall (large amount order) on the order book | maker | no | | wall | this strategy creates a wall (large amount of order) on the order book | maker | no |
| scmaker | this market making strategy is designed for stable coin markets, like USDC/USDT | maker | | | scmaker | this market making strategy is designed for stable coin markets, like USDC/USDT | maker | |
| drift | | long/short | | | drift | | long/short | |
| rsicross | this strategy opens a long position when the fast rsi cross over the slow rsi, this is a demo strategy for using the v2 indicator | long/short | | | rsicross | this strategy opens a long position when the fast rsi crosses over the slow rsi, this is a demo strategy for using the v2 indicator | long/short | |
| marketcap | this strategy implements a strategy that rebalances the portfolio based on the market capitalization | rebalance | no | | marketcap | this strategy implements a strategy that rebalances the portfolio based on the market capitalization | rebalance | no |
| supertrend | this strategy uses DEMA and Supertrend indicator to open the long/short position | long/short | | | supertrend | this strategy uses DEMA and Supertrend indicator to open the long/short position | long/short | |
| trendtrader | this strategy opens long/short position based on the trendline breakout | long/short | | | trendtrader | this strategy opens a long/short position based on the trendline breakout | long/short | |
| elliottwave | | long/short | | | elliottwave | | long/short | |
| ewoDgtrd | | long/short | | | ewoDgtrd | | long/short | |
| fixedmaker | | maker | | | fixedmaker | | maker | |
| factoryzoo | | long/short | | | factoryzoo | | long/short | |
| fmaker | | maker | | | fmaker | | maker | |
| linregmaker | a linear regression based market maker | maker | | | linregmaker | a linear regression based market maker | maker | |
| convert | convert strategy is a tool that helps you convert specific asset to a target asset | tool | no | | convert | convert strategy is a tool that helps you convert a specific asset to a target asset | tool | no |
@ -250,7 +250,7 @@ To start bbgo with the frontend dashboard:
bbgo run --enable-webserver bbgo run --enable-webserver
``` ```
If you want to switch to other dotenv file, you can add an `--dotenv` option or `--config`: If you want to switch to another dotenv file, you can add an `--dotenv` option or `--config`:
```sh ```sh
bbgo sync --dotenv .env.dev --config config/grid.yaml --session binance bbgo sync --dotenv .env.dev --config config/grid.yaml --session binance
@ -292,7 +292,7 @@ You could also add the script to crontab so that the system time could get synch
### Testnet (Paper Trading) ### Testnet (Paper Trading)
Currently only supports binance testnet. To run bbgo in testnet, apply new API keys Currently only supports Binance testnet. To run bbgo in testnet, apply new API keys
from [Binance Test Network](https://testnet.binance.vision), and set the following env before you start bbgo: from [Binance Test Network](https://testnet.binance.vision), and set the following env before you start bbgo:
```bash ```bash
@ -319,7 +319,7 @@ You can only use one database driver MySQL or SQLite to store your trading data.
#### Configure MySQL Database #### Configure MySQL Database
To use MySQL database for data syncing, first, you need to install your mysql server: To use MySQL database for data syncing, first, you need to install your MySQL server:
```sh ```sh
# For Ubuntu Linux # For Ubuntu Linux
@ -406,7 +406,7 @@ Check out the strategy directory [strategy](pkg/strategy) for all built-in strat
- `drift` - drift strategy. - `drift` - drift strategy.
- `grid2` - the second-generation grid strategy. - `grid2` - the second-generation grid strategy.
To run these built-in strategies, just modify the config file to make the configuration suitable for you, for example if To run these built-in strategies, just modify the config file to make the configuration suitable for you, for example, if
you want to run you want to run
`buyandhold` strategy: `buyandhold` strategy:
@ -524,7 +524,7 @@ bbgo userdatastream --session binance
In order to minimize the strategy code, bbgo supports dynamic dependency injection. In order to minimize the strategy code, bbgo supports dynamic dependency injection.
Before executing your strategy, bbgo injects the components into your strategy object if it found the embedded field Before executing your strategy, bbgo injects the components into your strategy object if it finds the embedded field
that is using bbgo component. for example: that is using bbgo component. for example:
```go ```go
@ -591,7 +591,7 @@ streambook.BindStream(stream)
1. Click the "Fork" button from the GitHub repository. 1. Click the "Fork" button from the GitHub repository.
2. Clone your forked repository into `$GOPATH/github.com/c9s/bbgo`. 2. Clone your forked repository into `$GOPATH/github.com/c9s/bbgo`.
3. Change the directory into `$GOPATH/github.com/c9s/bbgo`. 3. Change the directory to `$GOPATH/github.com/c9s/bbgo`.
4. Create a branch and start your development. 4. Create a branch and start your development.
5. Test your changes. 5. Test your changes.
6. Push your changes to your fork. 6. Push your changes to your fork.
@ -621,7 +621,7 @@ make embed && go run -tags web ./cmd/bbgo-lorca
### Looking For A New Strategy? ### Looking For A New Strategy?
You can write an article about BBGO on any topic, in 750-1500 words for exchange, and I can implement the strategy for You can write an article about BBGO on any topic, in 750-1500 words for exchange, and I can implement the strategy for
you (depending on the complexity and efforts). If you're interested in, DM me in telegram <https://t.me/c123456789s> or you (depending on the complexity and effort). If you're interested in, DM me in telegram <https://t.me/c123456789s> or
twitter <https://twitter.com/c9s>, and we can discuss. twitter <https://twitter.com/c9s>, and we can discuss.
### Adding New Crypto Exchange support? ### Adding New Crypto Exchange support?