Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aiee committed Sep 23, 2021
1 parent d865a43 commit a6da1c7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
**IMPORTANT: Code of Nebula go client has been transferred from [nebula-clients](https://github.com/vesoft-inc/nebula-clients) to this repository(nebula-go), and new releases in the future will be published in this repository.
Please update your go.mod and imports correspondingly.**

Official Nebula Go client which communicates with the server using [fbthrift](https://github.com/facebook/fbthrift/). Currently the latest stable release is **[v2.5.0](https://github.com/vesoft-inc/nebula-go/tree/release-v2.5.0)**
Official Nebula Go client which communicates with the server using [fbthrift](https://github.com/facebook/fbthrift/). Currently the latest stable release is **[v2.5.1](https://github.com/vesoft-inc/nebula-go/tree/release-v2.5.1)**

The code in **master branch** will be updated to accommodate the nightly changes made in Nebula Graph.
To Use the console with a stable release of Nebula Graph, please check the branches and use the corresponding version.
Expand All @@ -13,12 +13,14 @@ To Use the console with a stable release of Nebula Graph, please check the branc
|:--------------:|:-------------------:|
| **[v1.0.0](https://github.com/vesoft-inc/nebula-go/tree/v1.0)** | 1.x.x |
| **[v2.0.0-ga](https://github.com/vesoft-inc/nebula-go/tree/v2.0.0-ga)** | 2.0.0-ga, 2.0.1 |
| **[v2.5.0](https://github.com/vesoft-inc/nebula-go/tree/v2.5.0)** | >=2.5.0 |
| **[v2.5.1](https://github.com/vesoft-inc/nebula-go/tree/v2.5.1)** | >=2.5.0 |
| **[master](https://github.com/vesoft-inc/nebula-go/tree/master)** | 2.x-nightly |


Please be careful not to modify the files in the nebula directory, these codes were all generated by fbthrift.

**NOTE** Installing Nebula Go v2.5.0 could cause **checksum mismatch**, use v2.5.1 instead.

## Install & Update

```shell
Expand All @@ -29,7 +31,7 @@ $ go get -u -v github.com/vesoft-inc/nebula-go/v2@master
$ go get -u -v github.com/vesoft-inc/nebula-go/@master
```
You can specify the version of Nebula-go by substituting `<tag>` in `$ go get -u -v github.com/vesoft-inc/nebula-go@<tag>`.
For example: `$ go get -u -v github.com/vesoft-inc/nebula-go/v2@v2.5.0`
For example: `$ go get -u -v github.com/vesoft-inc/nebula-go/v2@v2.5.1`

**Note**: You will get a message like this if you don't specify a tag:
> ```
Expand Down

0 comments on commit a6da1c7

Please sign in to comment.