create a proper doc.go

carapace · Oct 24, 2018 · d090d4d · d090d4d
1 parent 6162a16
commit d090d4d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 11 deletions.
diff --git a/doc.go 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