You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by me...@apache.org on 2020/07/22 03:15:40 UTC
[shardingsphere] branch master updated: fix readme
This is an automated email from the ASF dual-hosted git repository.
menghaoran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 03d9abf fix readme
new 2b04b39 Merge pull request #6386 from kimmking/fixReadme
03d9abf is described below
commit 03d9abf41b8660f08b7be5eda07a81b93d654bdd
Author: kimmking <ki...@apache.org>
AuthorDate: Tue Jul 21 22:39:27 2020 +0800
fix readme
---
README.md | 26 +++++++++++++-------------
README_ZH.md | 2 +-
examples/README.md | 21 +++------------------
examples/README_ZH.md | 21 +++------------------
4 files changed, 20 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 95cb047..d85ca94 100644
--- a/README.md
+++ b/README.md
@@ -27,9 +27,9 @@ They all provide functions of data sharding, distributed transaction and databas
Aiming at reasonably making full use of the computation and storage capacity of database in distributed system, ShardingSphere defines itself as a middleware, rather than a totally new type of database.
As the cornerstone of many enterprises, relational database still takes a huge market share. Therefore, at current stage, we prefer to focus on its increment instead of a total overturn.
-Apache ShardingSphere begin to focus on pluggable architecture from version 5.x, features can be embedded into project flexibility.
+Apache ShardingSphere begins to focus on pluggable architecture from version 5.x, features can be embedded into project flexibility.
Currently, the features such as data sharding, read-write splitting, multi replica, data encrypt, shadow test, and SQL dialects / database protocols such as MySQL, PostgreSQL, SQLServer, Oracle supported are all weaved by plugins.
-Developers can customize their own ShardingSphere just like building lego blocks. There are lots of SPI extensions for Apache ShardingSphere now and increase continuously.
+Developers can customize their own ShardingSphere systems just like building lego blocks. There are lots of SPI extensions for Apache ShardingSphere now and increasing continuously.
ShardingSphere became an [Apache](https://apache.org/index.html#projects-list) Top Level Project on April 16 2020.
@@ -41,13 +41,13 @@ Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apa
[](https://mvnrepository.com/artifact/org.apache.shardingsphere/sharding-jdbc)
-ShardingSphere-JDBC defines itself as a lightweight Java framework that provides extra service at Java JDBC layer.
-With the client end connecting directly to the database, it provides service in the form of jar and requires no extra deployment and dependence.
+ShardingSphere-JDBC defines itself as a lightweight Java framework that provides extra services at Java JDBC layer.
+With the client end connecting directly to the database, it provides services in the form of jar and requires no extra deployment and dependence.
It can be considered as an enhanced JDBC driver, which is fully compatible with JDBC and all kinds of ORM frameworks.
* Applicable in any ORM framework based on JDBC, such as JPA, Hibernate, Mybatis, Spring JDBC Template or direct use of JDBC.
* Support any third-party database connection pool, such as DBCP, C3P0, BoneCP, Druid, HikariCP.
-* Support any kind of JDBC standard database: MySQL, Oracle, SQLServer, PostgreSQL and any SQL92 followed databases.
+* Support any kind of JDBC standard database: MySQL, Oracle, SQLServer, PostgreSQL and any SQL92 followed database.
@@ -57,9 +57,9 @@ It can be considered as an enhanced JDBC driver, which is fully compatible with
[](https://store.docker.com/community/images/shardingsphere/sharding-proxy)
ShardingSphere-Proxy defines itself as a transparent database proxy, providing a database server that encapsulates database binary protocol to support heterogeneous languages.
-Friendlier to DBA, the MySQL/PostgreSQL version provided now can use any kind of client access (such as MySQL Command Client, MySQL Workbench, Navicat etc.) that is compatible of MySQL/PostgreSQL protocol to operate data.
+Friendlier to DBA, the proxy of MySQL/PostgreSQL version provided now can use any kind of client access (such as MySQL Command Client, MySQL Workbench, Navicat etc.) that is compatible of MySQL/PostgreSQL protocol to operate data.
-* Totally transparent to applications, it can be used directly as MySQL and PostgreSQL.
+* Totally transparent to applications, it can be used directly as MySQL and PostgreSQL server.
* Applicable to any kind of compatible client end that is compatible with MySQL and PostgreSQL protocol.
@@ -69,9 +69,9 @@ Friendlier to DBA, the MySQL/PostgreSQL version provided now can use any kind of
ShardingSphere-Sidecar (TODO) defines itself as a cloud native database agent of the Kubernetes environment, in charge of all the access to the database in the form of sidecar.
It provides a mesh layer interacting with the database, we call this as `Database Mesh`.
-Database Mesh emphasizes on how to connect distributed database access application with the database.
-Focusing on interaction, it effectively organizes the interaction between messy applications and the database.
-The application and database that use Database Mesh to visit database will form a large grid system, where they just need to be put into the right position accordingly.
+Database Mesh emphasizes on how to connect distributed data-access applications with the databases.
+Focusing on interaction, it effectively organizes the interaction between messy applications and the databases.
+The applications and databases those use Database Mesh to visit databases will form a large grid system, where they just need to be put into the right positions accordingly.
They are all governed by the mesh layer.
@@ -87,10 +87,10 @@ They are all governed by the mesh layer.
### Hybrid Architecture
-ShardingSphere-JDBC adopts decentralized architecture, applicable to high-performance light-weight OLTP application developed with Java;
-ShardingSphere-Proxy provides static entry and all languages support, applicable for OLAP application and the sharding databases management and operation situation.
+ShardingSphere-JDBC adopts decentralized architecture, applicable to high-performance light-weight OLTP applications developed with Java;
+ShardingSphere-Proxy provides static entry and all languages support, applicable for OLAP applications and the sharding databases management and operation situation.
-ShardingSphere is an ecosphere consists of multiple endpoints together.
+ShardingSphere is an ecosphere consisted of multiple endpoints together.
Through a mixed use of ShardingSphere-JDBC and ShardingSphere-Proxy and unified sharding strategy by the same registry center, ShardingSphere can build an application system applicable to all kinds of scenarios.
Architects can adjust the system architecture to the most applicable one to current business more freely.
diff --git a/README_ZH.md b/README_ZH.md
index 0b1e258..edc59ff 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -56,7 +56,7 @@ ShardingSphere 已于2020年4月16日成为 [Apache 软件基金会](https://apa
定位为透明化的数据库代理端，提供封装了数据库二进制协议的服务端版本，用于完成对异构语言的支持。
目前提供 MySQL 和 PostgreSQL 版本，它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端(如：MySQL Command Client, MySQL Workbench, Navicat 等)操作数据，对 DBA 更加友好。
-* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 使用。
+* 向应用程序完全透明，可直接当做 MySQL/PostgreSQL 服务端使用。
* 适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。
diff --git a/examples/README.md b/examples/README.md
index 32209d7..a8f76fb 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -14,7 +14,7 @@ Example for 2.x or 3.x or 4.x please see tags in `https://github.com/apache/shar
## Before start the example if you want use `dev` branch
-Please make sure some dependencies from [shardingsphere](https://github.com/apache/shardingsphere) and [shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl) have been installed since some examples depend on that.
+Please make sure some dependencies from [shardingsphere](https://github.com/apache/shardingsphere) has been installed since some examples depend on that.
if you are a newbie for shardingsphere, you could prepare the dependencies as following:
1.download and install [shardingsphere](https://github.com/apache/shardingsphere):
@@ -23,26 +23,11 @@ if you are a newbie for shardingsphere, you could prepare the dependencies as fo
## download the code of shardingsphere
git clone https://github.com/apache/shardingsphere.git
-## checkout a specific version, example is 4.0.0-RC1
-cd shardingsphere && git checkout 4.0.0-RC1
-
## install the dependencies
+cd shardingsphere/examples
mvn clean install -Prelease
```
-2.download and install [shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl):
-
-```bash
-## download the code of shardingsphere-spi-impl
-git clone https://github.com/OpenSharding/shardingsphere-spi-impl.git
-
-## checkout a specific version, example is 4.0.0-RC1
-cd shardingsphere-spi-impl && git checkout 4.0.0-RC1
-
-## install the dependencies
-mvn clean install
-```
-
## shardingsphere-example module design
### project structure
@@ -68,7 +53,7 @@ shardingsphere-example
│ │ └── orchestration-spring-namespace-example
│ ├── transaction-example
│ │ ├── transaction-2pc-xa-example
- │ │ └──transaction-base-seata-example
+ │ │ └── transaction-base-seata-example
│ ├── other-feature-example
│ │ ├── hint-example
│ │ └── encrypt-example
diff --git a/examples/README_ZH.md b/examples/README_ZH.md
index 2bdbc7a..22fd51a 100644
--- a/examples/README_ZH.md
+++ b/examples/README_ZH.md
@@ -14,7 +14,7 @@
## 如果要使用`dev`分支，请在开始该example之前
-请确保已安装了来自[shardingsphere](https://github.com/apache/shardingsphere) 和 [shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl)的某些依赖项，因为某些示例依赖于此。如果您是shardingsphere的新手，您可以准备如下依赖：
+请确保已安装了来自[shardingsphere](https://github.com/apache/shardingsphere) 的某些依赖项，因为某些示例依赖于此。如果您是shardingsphere的新手，您可以准备如下依赖：
1.下载并安装[shardingsphere](https://github.com/apache/shardingsphere)：
@@ -22,26 +22,11 @@
## 下载shardingsphere代码
git clone https://github.com/apache/shardingsphere.git
-## 检出一个指定版本，比如是 4.0.0-RC1
-cd shardingsphere && git checkout 4.0.0-RC1
-
## 安装依赖
+cd shardingsphere/examples
mvn clean install -Prelease
```
-2.下载并安装[shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl)：
-
-```bash
-## 下载shardingsphere-SPI-implement的代码
-git clone https://github.com/OpenSharding/shardingsphere-spi-impl.git
-
-## 检出一个指定版本，比如是 4.0.0-RC1
-cd shardingsphere-spi-impl && git checkout 4.0.0-RC1
-
-## 安装依赖
-mvn clean install
-```
-
## shardingsphere-example模块设计
### 项目结构
@@ -67,7 +52,7 @@ shardingsphere-example
│ │ └── orchestration-spring-namespace-example
│ ├── transaction-example
│ │ ├── transaction-2pc-xa-example
- │ │ └──transaction-base-seata-example
+ │ │ └── transaction-base-seata-example
│ ├── other-feature-example
│ │ ├── hint-example
│ │ └── encrypt-example