open-vault/vendor/github.com/couchbase/gocb/v2/README.md

54 lines
1.8 KiB
Markdown

[![GoDoc](https://godoc.org/github.com/couchbase/gocb?status.png)](https://godoc.org/github.com/couchbase/gocb)
# Couchbase Go Client
This is the official Couchbase Go SDK. If you are looking for our
previous unofficial prototype Go client library, please see:
[http://www.github.com/couchbase/go-couchbase](http://www.github.com/couchbase/go-couchbase).
The Go SDK library allows you to connect to a Couchbase cluster from
Go. It is written in pure Go, and uses the included gocbcore library to
handle communicating to the cluster over the Couchbase binary
protocol.
## Useful Links
### Source
The project source is hosted at [http://github.com/couchbase/gocb](http://github.com/couchbase/gocb).
### Documentation
You can explore our API reference through godoc at [https://godoc.org/github.com/couchbase/gocb](https://godoc.org/github.com/couchbase/gocb).
You can also find documentation for the Go SDK at the Couchbase [Developer Portal](https://developer.couchbase.com/documentation/server/current/sdk/go/start-using-sdk.html).
### Bug Tracker
Issues are tracked on Couchbase's public [issues.couchbase.com](http://www.couchbase.com/issues/browse/GOCBC).
Contact [the site admins](https://issues.couchbase.com/secure/ContactAdministrators!default.jspa)
regarding login or other problems at issues.couchbase.com (officially) or ask
around in [couchbase/discuss on gitter.im](https://gitter.im/couchbase/discuss)
(unofficially).
## Installing
To install the latest stable version, run:
```bash
go get github.com/couchbase/gocb/v2
```
To install the latest developer version, run:
```bash
go get github.com/couchbase/gocb
```
## License
Copyright 2016 Couchbase Inc.
Licensed under the Apache License, Version 2.0.
See
[LICENSE](https://github.com/couchbase/gocb/blob/master/LICENSE)
for further details.