-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e5d6cdc
commit 9018a6c
Showing
1 changed file
with
20 additions
and
0 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,2 +1,22 @@ | ||
# gkvstore [![Go](https://github.com/plexsysio/gkvstore/workflows/Go/badge.svg)](https://github.com/plexsysio/gkvstore/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/plexsysio/gkvstore.svg)](https://pkg.go.dev/github.com/plexsysio/gkvstore) [![Coverage Status](https://coveralls.io/repos/github/plexsysio/gkvstore/badge.svg?branch=main)](https://coveralls.io/github/plexsysio/gkvstore?branch=main) | ||
Generic key-value store | ||
|
||
gkvstore is a generic KV Store interface which provides an easier | ||
interface to access underlying database. It is mainly used to abstract | ||
the database used underneath so we can have a uniform API to use for clients | ||
|
||
Different DB adapters can be built for the Store. This allows decoupling DB code | ||
from specific implementations and ability to change DBs on the fly. | ||
|
||
|
||
## Install | ||
`gkvstore` works like a regular Go module: | ||
|
||
``` | ||
> go get github.com/plexsysio/gkvstore | ||
``` | ||
|
||
## Usage | ||
```go | ||
import "github.com/plexsysio/gkvstore" | ||
``` |