Merge pull request FISCO-BCOS#573 from chaychen2005/master

add version compatibility instructions
ccDown · Mar 18, 2019 · 2467ddf · 2467ddf
2 parents c709cd7 + 9c31828
commit 2467ddf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -41,3 +41,7 @@
 
 1. 提供入门级的搭链工具
 2. 提供模块化的单元测试和端对端集成测试，支持自动化持续集成和持续部署
+
+**兼容性说明**
+
+2.0版本与1.0版本数据和协议不兼容，合约兼容。如果要从1.3版本升级到2.0版本，需要做数据迁移。
diff --git a/README.md b/README.md
@@ -13,21 +13,25 @@ English / [中文](docs/README_CN.md)
 
 - [**中文**](https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.0/)
 
+## Compatibility
+
+Version 2.0 introduces new internal block data formats and network protocols for new features and improved capabilities. For the users of version 1.3, the existing smart contracts can be directly reused on version 2.0, but extra data migration will be required to upgrade from version 1.3 to version 2.0.
+
 ## Developing & Contributing
 
 - Star our Github.
 - Pull requests. See [CONTRIBUTING](CONTRIBUTING.md) and [CODING_STYLE](CODING_STYLE.md).
 - [Ask questions](https://github.com/FISCO-BCOS/FISCO-BCOS/issues).
 - Discuss in [WeChat group](docs/images/WeChatQR.jpeg) or [Gitter](https://gitter.im/fisco-bcos/Lobby).
 
-### Features
+## Features
 
 **Security**: Support the sensitive financial business scenarios by providing advanced security features including node access management, data permission control, CA certificate verification, guomi crypto support.
 **Performance**: Tackle high transaction throughput with optimization technologies including parallel transaction processing, precompiled smart contracts, advanced mass database.
 **Reliability**: Verified by multiple running cross-organization financial applications.
 **Usability**: Offer user-friendly and comprehensive toolkits including interactive console, deployment tools, block browsers, SDK, and other supporting tools.
 
-### Featured Cases
+## Featured Cases
 
 Since FISCO BCOS launched, dozens of applications have been implemented. See [FEATURED CASES](http://www.fisco-bcos.org/assets/docs/FISCO%20BCOS%20-%20Featured%20Cases.pdf).
 

diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -12,6 +12,10 @@
 
 - [**中文**](https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.0/)
 
+## 兼容性说明
+
+2.0版本与1.0版本数据和协议不兼容，合约兼容。如果要从1.3版本升级到2.0版本，需要做数据迁移。
+
 ## 贡献代码
 
 要参与进来，很简单，你可以：
@@ -21,14 +25,14 @@
 - 也可以[提问](https://github.com/FISCO-BCOS/FISCO-BCOS/issues)和[提交BUG](https://github.com/FISCO-BCOS/FISCO-BCOS/issues)。
 - 或者可以在[微信群](images/WeChatQR.jpeg)和[Gitter](https://gitter.im/fisco-bcos/Lobby)里讨论。
 
-### 关键特性
+## 关键特性
 
 - **安全**：提供准入机制、权限控制、CA认证，密钥管理，国密等高级安全功能，满足金融级商业应用场景需求。
 - **性能**：提供并行交易处理、预编译合约、分布式存储等功能，能够高效地处理大吞吐量的交易请求。
 - **稳定**：已有多个跨机构的金融级商业应用落地，长时间的实践检验了其稳定性。
 - **易用**：提供控制台、部署工具、浏览器和SDK等配套工具，便于用户快速上手。
 
-### 落地应用案例
+## 落地应用案例
 
 FISCO BCOS有很多的应用案例。此处提供一些具有代表性的[落地应用案例](https://www.fisco.com.cn/files/FISCOBCOS_FeaturedCases.pdf)。