Skip to content

Commit

Permalink
[Mod] translate README.md to English
Browse files Browse the repository at this point in the history
  • Loading branch information
veighna-global committed Mar 12, 2024
1 parent a5fea7d commit 73683c1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
37 changes: 17 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,51 @@
# vn.py框架的BINANCE底层接口
# Binance trading gateway for VeighNa Evo

<p align="center">
<img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png"/>
<img src ="https://github.com/veighna-global/vnpy_evo/blob/dev/logo.png" width="300" height="300"/>
</p>

<p align="center">
<img src ="https://img.shields.io/badge/version-2022.4.28-blueviolet.svg"/>
<img src ="https://img.shields.io/badge/version-2024.3.12-blueviolet.svg"/>
<img src ="https://img.shields.io/badge/platform-windows|linux|macos-yellow.svg"/>
<img src ="https://img.shields.io/badge/python-3.7|3.8|3.9|3.10-blue.svg" />
<img src ="https://img.shields.io/github/license/vnpy/vnpy.svg?color=orange"/>
<img src ="https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg"/>
<img src ="https://img.shields.io/github/license/veighna-global/vnpy_evo.svg?color=orange"/>
</p>


## 说明
## Introduction

基于币安交易所的API开发,支持账户下的现货、期货、永续交易。
This gateway is developed based on Binance's REST and Websocket API, and supports spot, linear contract and inverse contract trading.

使用时需要注意本接口:
**For derivatives contract trading, please notice:**

1. 只支持全仓保证金模式
2. 只支持单向持仓模式
1. Only supports cross margin mode.
2. Only supports one-way position mode.

请在BINANCE网站完成账户的相应设置后再使用。
## Install

## 安装

安装需要基于3.0.0版本以上的[VN Studio](https://www.vnpy.com)

直接使用pip命令:
Users can easily install ``vnpy_binance`` by pip according to the following command.

```
pip install vnpy_binance
```

下载解压后在cmd中运行
Also, users can install ``vnpy_binance`` using the source code. Clone the repository and install as follows:

```
git clone https://github.com/veighna-global/vnpy_binance.git && cd vnpy_binance
python setup.py install
```

## 使用
## A Simple Example

以脚本方式启动(script/run.py):
Save this as run.py.

```
from vnpy_evo.event import EventEngine
from vnpy_evo.trader.engine import MainEngine
from vnpy_evo.trader.ui import MainWindow, create_qapp
import vnpy_evo
from vnpy_binance import (
BinanceSpotGateway,
BinanceLinearGateway,
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = vnpy_binance
version = attr: vnpy_binance.__version__
author = VeighNa Global
author_email = [email protected]
description = BINANCE trading gateway for VeighNa.
description = BINANCE trading gateway for VeighNa Evo.
long_description = file: README.md
long_description_content_type = text/markdown
url = https://www.github.com/veighna-global
Expand Down

0 comments on commit 73683c1

Please sign in to comment.