Skip to content

Commit

Permalink
chore: sync CN EN readme (#388)
Browse files Browse the repository at this point in the history
  • Loading branch information
Koooooo-7 committed Feb 4, 2024
1 parent 3b17b94 commit a4952c0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ which `go-echarts` learns and has evolved a lot from.
Classic way to get go-echarts

```shell
# this may be a stupid way to use v2 go-echarts without gomod(GO111MODULE=off) because of
# the next generation version management system... 🐶
# if you get a better workaround, please let me know....
# this may be not a good choice to use v2 go-echarts without gomod(GO111MODULE=off), the
# next generation version management system
# Technically, you could use go-echarts in the way below, if you have a better workaround, please let us know....

$ go get -u github.com/go-echarts/go-echarts/...
$ cd $go-echarts-project
Expand Down Expand Up @@ -80,10 +80,8 @@ v1 and v2 are incompatible which means that you cannot upgrade go-echarts from v
worth trying that new version.

Especially, when there contains mino changes (usually in enhancement), we will release the `rc` version before a
standard
release.
So, if you upgrade your projects cross the `rc` versions, maybe
need little adjust.
standard release.
So, if you upgrade your projects cross the `rc` versions, maybe need little adjust, and I believe it is worthy to do.

### ✨ Features

Expand Down Expand Up @@ -222,7 +220,7 @@ func main() {
<img src="https://user-images.githubusercontent.com/19553554/52349544-c2ce3900-2a61-11e9-82af-28aaaaae0d67.gif" width="33%" alt="overlap"/>
</div>

For more information, please refer to [go-echarts/examples](https://github.com/go-echarts/examples) and
For more information, please refer to [handbook](https://go-echarts.github.io/go-echarts/), [go-echarts/examples](https://github.com/go-echarts/examples) and
the [GoDoc](https://pkg.go.dev/github.com/go-echarts/go-echarts/v2).

### Ecosystem
Expand Down
13 changes: 7 additions & 6 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@

> 如果一门语言可以用来写爬虫,那么它就需要一个优雅的数据可视化库。 --- by dongdong
在 Golang 这门语言中,目前数据可视化的第三方库还是特别少,[go-echarts](https://github.com/go-echarts/go-echarts) 的开发就是为了填补这部分的空隙。
在 Golang 这门语言中,目前数据可视化的第三方库还是特别少,[go-echarts](https://github.com/go-echarts/go-echarts)
的开发就是为了填补这部分的空隙。
[Apache ECharts](http://echarts.apache.org/) 是非常优秀的可视化图表库,凭借着良好的交互性,精巧的图表设计,得到了众多开发者的认可。
也有其他语言为其实现了相应语言版本的接口,如 Python 的 [pyecharts](https://github.com/pyecharts/pyecharts)
go-echarts 也从 pyecharts 借鉴了一些设计思想。


### 🔰 安装

GOPATH
Expand All @@ -57,7 +57,8 @@ require github.com/go-echarts/go-echarts/v2

### ⏳ 版本

go-echarts 现在有 v1 和 v2 两个大版本,v1 版本的代码位于 v1 分支下,v2 代码位于 master 分支下。两个大版本是不兼容的,且 v1 不会再维护了,所以欢迎使用 v2 版本。
go-echarts 现在有 v1 和 v2 两个大版本,v1 版本的代码位于 v1 分支下,v2 代码位于 master 分支下。两个大版本是不兼容的,且 v1
不会再维护了,所以欢迎使用 v2 版本。

特别的,当有一些小的改动时(通常做的部分重构)会先发布rc版本,表示这是一个待发布的新的可能有小改动的版本(非breaking)。
如果跨rc版本对已有的项目直接升级时,可能需要小调整一下代码。
Expand All @@ -72,6 +73,9 @@ go-echarts 现在有 v1 和 v2 两个大版本,v1 版本的代码位于 v1 分

### 📝 使用

使用`go-echarts`
可以参考[handbook](https://go-echarts.github.io/go-echarts), [go-echarts/examples](https://github.com/go-echarts/examples)
[GoDocs](https://pkg.go.dev/github.com/go-echarts/go-echarts/v2).
仅需要几行核心代码就可画出美观的图表

```golang
Expand Down Expand Up @@ -167,7 +171,6 @@ func main() {

![image](https://user-images.githubusercontent.com/19553554/98436642-044cb600-2118-11eb-9f35-784948a92cb5.png)


### 🔖 Gallery

<div align="center">
Expand Down Expand Up @@ -197,8 +200,6 @@ func main() {
<img src="https://user-images.githubusercontent.com/19553554/52349544-c2ce3900-2a61-11e9-82af-28aaaaae0d67.gif" width="33%" alt="overlap"/>
</div>

了解更多文档的内容请访问 [go-echarts/examples](https://github.com/go-echarts/examples) 以及 [GoDoc](https://pkg.go.dev/github.com/go-echarts/go-echarts/v2)

### 📃 License

MIT [©go-echarts](https://github.com/go-echarts/go-echarts/blob/master/LICENSE)

0 comments on commit a4952c0

Please sign in to comment.