-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
- Loading branch information
Lutkin Wang
authored
Mar 10, 2020
1 parent
de0b633
commit e18efab
Showing
1 changed file
with
34 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,42 @@ | ||
## milvus-sdk-go | ||
Go SDK for Milvus distributed high-performance vector search engine | ||
## Milvus Go SDK | ||
|
||
We welcome all kinds of contributions for milvus-sdk-go. | ||
Go SDK for [Milvus](https://github.com/milvus-io/milvus). To contribute code to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first. | ||
|
||
|Milvus version| Recommended Go SDK version | | ||
|:-----:|:-----:| | ||
| 0.7.0 | 0.1.0| | ||
|
||
### Getting started | ||
You will need go 1.12 | ||
|
||
#### Install | ||
Use go get to install the latest version of the library. This command will install the milvus-go-sdk library and its dependencies: | ||
```shell | ||
go get -u github.com/milvus-io/milvus-sdk-go/milvus | ||
``` | ||
Next, include milvus-sdk-go in your application: | ||
```shell | ||
import "github.com/milvus-io/milvus-sdk-go/milvus" | ||
``` | ||
### Try go example | ||
#### Prerequisites | ||
|
||
Go 1.12 or higher | ||
|
||
#### Install Milvus Go SDK | ||
|
||
1. Use `go get` to install the latest version of the Milvus Go SDK and dependencies: | ||
|
||
```shell | ||
go get -u github.com/milvus-io/milvus-sdk-go/milvus | ||
``` | ||
|
||
2. Include the Milvus Go SDK in your application: | ||
|
||
```shell | ||
import "github.com/milvus-io/milvus-sdk-go/milvus" | ||
``` | ||
|
||
#### Try an example | ||
|
||
```shell | ||
cd [milvus-sdk-go root path]/examples | ||
go run MilvusClientExample.go | ||
``` | ||
### Additional information | ||
- The go source code is formatted using go fmt and golint | ||
|
||
### API Documentation | ||
|
||
Refer to [https://godoc.org/github.com/milvus-io/milvus-sdk-go/milvus](https://godoc.org/github.com/milvus-io/milvus-sdk-go/milvus) for the GO SDK API documentation. | ||
|
||
### Code format | ||
|
||
The Go source code is formatted using gofmt and golint. |