Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiandongx committed Nov 19, 2020
1 parent cbb8977 commit 9875b78
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="MIT License">
</a>
<a href="https://pkg.go.dev/github.com/go-echarts/go-echarts/v2">
<a href="https://pkg.go.dev/github.com/go-echarts/go-echarts/v2">
<img src="https://godoc.org/github.com/go-echarts/go-echarts?status.svg" alt="GoDoc">
</a>
</p>
Expand All @@ -36,26 +36,34 @@ In the Golang ecosystem, there are not many choices for data visualization libra
Classic way to get go-echarts

```shell
$ go get -u github.com/go-echarts/go-echarts/...

# this may be a stupid way to use v2 go-echarts without gomod(GO111MODULE=off) because of
# the gomod version management system... 🐶
# the next generation version management system... 🐶
# if you get a better workaround, please let me know....

$ go get -u github.com/go-echarts/go-echarts/...
$ cd $go-echarts-project
$ mkdir v2 && mv charts components datasets opts render templates types v2
```

Use gomod style

```shell
$ go get -u github.com/go-echarts/go-echarts/v2/...
```

OR

```shell
# go.mod

require github.com/go-echarts/go-echarts/v2
```

### ⏳ Version

The go-echarts project is being developed under v2 version and the active codebase is on the master branch now.

v1 and v2 are incompatible which means that you cannot upgrade go-echarts from v1 to v2 smoothly. But I think it is worth trying the new version.
v1 and v2 are incompatible which means that you cannot upgrade go-echarts from v1 to v2 smoothly. But I think it is worth trying that new version.

### ✨ Features

Expand Down

0 comments on commit 9875b78

Please sign in to comment.