github.com/go-kivik/kivik/v4@v4.3.2/couchdb/README.md (about)

     1  [![Go Reference](https://pkg.go.dev/badge/github.com/go-kivik/kivik/v4/couchdb.svg)](https://pkg.go.dev/github.com/go-kivik/kivik/v4/couchdb)
     2  
     3  # Kivik CouchDB
     4  
     5  CouchDB driver for [Kivik](https://github.com/go-kivik/kivik).
     6  
     7  ## Usage
     8  
     9  This package provides an implementation of the
    10  [`github.com/go-kivik/kivik/v4/driver`](http://pkg.go.dev/github.com/go-kivik/kivik/v4/driver)
    11  interface. You must import the driver and can then use the full
    12  [`Kivik`](http://pkg.go.dev/github.com/go-kivik/kivik/v4) API.
    13  
    14  ```go
    15  package main
    16  
    17  import (
    18      "context"
    19  
    20      kivik "github.com/go-kivik/kivik/v4"
    21      _ "github.com/go-kivik/kivik/v4/couchdb" // The CouchDB driver
    22  )
    23  
    24  func main() {
    25      client, err := kivik.New(context.TODO(), "couch", "")
    26      // ...
    27  }
    28  ```
    29  
    30  ## License
    31  
    32  This software is released under the terms of the Apache 2.0 license. See
    33  LICENCE.md, or read the [full license](http://www.apache.org/licenses/LICENSE-2.0).