# README
Kivik FSDB
Experimental file system driver for Kivik.
This driver stores documents on a plain filesystem.
Status
This is very much a work in progress. Things are expected to change quickly.
Usage
This package provides an implementation of the
github.com/go-kivik/kivik/driver
interface. You must import the driver and can then use the full
Kivik
API.
package main
import (
"context"
"github.com/go-kivik/kivik/v4"
_ "github.com/go-kivik/kivik/v4/x/fsdb" // The File system driver
)
func main() {
client, err := kivik.New(context.TODO(), "fs", "")
// ...
}
License
This software is released under the terms of the Apache 2.0 license. See LICENCE.md, or read the full license.
# Packages
Package cdb provides the core CouchDB types.
Package filesystem provides an abstraction around a filesystem.
Package test configures the integration test suite.