diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..3928cfc --- /dev/null +++ b/doc.go @@ -0,0 +1,10 @@ +/* +package cellar implements a low level, append only data storage engine. + +cellar was originally forked from abdullin/cellar. This version focusses on a more standard API, less built in features +and more configurability. It is used in carapace/core/pkg/append-db (versioned object DB) as the storage engine. + +It is completely embedded, internally buffering writes until chunks are filled up, then automatically flushing them to +file. See the example for a full usage of cellar. +*/ +package cellar diff --git a/dto.pb.go b/dto.pb.go index 63aeb24..12e535f 100644 --- a/dto.pb.go +++ b/dto.pb.go @@ -2,17 +2,6 @@ // source: dto.proto // DO NOT EDIT! -/* -Package cellar is a generated protocol buffer package. - -It is generated from these files: - dto.proto - -It has these top-level messages: - ChunkDto - BufferDto - MetaDto -*/ package cellar import proto "github.com/golang/protobuf/proto"