README.md

Documentation: github.com/go-kivik/kivik/v4/x/fsdb

     1[![Go Reference](https://pkg.go.dev/badge/github.com/go-kivik/kivik/v4/x/fsdb.svg)](https://pkg.go.dev/github.com/go-kivik/kivik/v4/x/fsdb)
     2
     3# Kivik FSDB
     4
     5Experimental file system driver for [Kivik](https://github.com/go-kivik/kivik).
     6
     7This driver stores documents on a plain filesystem.
     8
     9# Status
    10
    11This is very much a work in progress. Things are expected to change quickly.
    12
    13## Usage
    14
    15This package provides an implementation of the
    16[`github.com/go-kivik/kivik/driver`](http://pkg.go.dev/github.com/go-kivik/kivik/v4/driver)
    17interface. You must import the driver and can then use the full
    18[`Kivik`](http://pkg.go.dev/github.com/go-kivik/kivik/v4) API.
    19
    20```go
    21package main
    22
    23import (
    24    "context"
    25
    26    "github.com/go-kivik/kivik/v4"
    27    _ "github.com/go-kivik/kivik/v4/x/fsdb" // The File system driver
    28)
    29
    30func main() {
    31    client, err := kivik.New(context.TODO(), "fs", "")
    32    // ...
    33}
    34```
    35
    36## License
    37
    38This software is released under the terms of the Apache 2.0 license. See
    39LICENCE.md, or read the [full license](http://www.apache.org/licenses/LICENSE-2.0).
View as plain text