Merge pull request #1 from ipfs/initial-code

initial code commit

Author: gammazero

README.md

@@ -1,17 +1,16 @@
-Repository Name
-=======================
+# go-dsqueue
 
-> Repository tagline
+[![Build Status](https://img.shields.io/github/actions/workflow/status/ipfs/go-dsqueue/go-test.yml?branch=main)](https://github.com/ipfs/go-dsqueue/actions)
+[![GoDoc](https://pkg.go.dev/badge/github.com/ipfs/go-dsqueue)](https://pkg.go.dev/github.com/ipfs/go-dsqueue)
 
-A longer repository description.
 
-## Documentation
+> Buffered FIFO interface to the datastore
 
-[Insert link to documentation]() or expand with Install, Build, Usage sections.
+The dsqueue package provides a buffered FIFO queue backed by a [Batching Datastore](https://pkg.go.dev/github.com/ipfs/go-datastore#Batching). Queued items are persisted in the datastore when the input buffer is full, after some amount of idle time, and when the queue is shuddown.
 
-## Lead Maintainer
+## Documentation
 
-[Your name](https://github.com/alinktoyourname)
+https://pkg.go.dev/github.com/ipfs/go-dsqueue
 
 ## Contributing
 

doc.go

@@ -0,0 +1,3 @@
+// Package dsqueue provides a buffered FIFO interface to the datastore for
+// storing and retrieving items. Queued items are persisted across restarts.
+package dsqueue