Skip to content

Commit

Permalink
db/kv: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukasmacko
lukasmacko committed Jul 6, 2017
1 parent 2c71802 commit 8add951
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion db/keyval/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@

The package defines API for access to key-value data store. `Broker` interface allows to read and manipulate key-value pairs.
`Watcher` provides functions for monitoring of changes in a datastore. Both interfaces are available with arguments
of type `[]bytes` and `proto.Message`.
of type `[]bytes` and `proto.Message`.

The package also provides a skeleton for a key-value plugin. The particular data store is selected
in the constructor `NewSkeleton` using argument of type `CoreBrokerWatcher`. The skeleton handles the plugins life-cycle
and provides unified access to datastore implementing `KvPlugin` interface.

0 comments on commit 8add951

Please sign in to comment.