diff --git a/LICENSE b/LICENSE index 4bc9676..87fd6d9 100644 --- a/LICENSE +++ b/LICENSE @@ -337,4 +337,4 @@ Mozilla Public License, version 2.0 Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be - attached. \ No newline at end of file + attached. diff --git a/README.md b/README.md index 851ec14..40f3b1e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -scribble +Scribble [![Coverage Status](https://coveralls.io/repos/github/nanobox-io/golang-scribble/badge.svg?branch=master)](https://coveralls.io/github/nanobox-io/golang-scribble?branch=master) [![GoDoc](https://godoc.org/github.com/boltdb/bolt?status.svg)](http://godoc.org/github.com/nanobox-io/golang-scribble) [![Go Report Card](https://goreportcard.com/badge/github.com/nanobox-io/golang-scribble)](https://goreportcard.com/report/github.com/nanobox-io/golang-scribble) -------- A tiny JSON database in Golang diff --git a/scribble.go b/scribble.go index 1f140f3..983bb6b 100644 --- a/scribble.go +++ b/scribble.go @@ -1,21 +1,23 @@ -// scribble is a tiny JSON database +// Package scribble is a tiny JSON database package scribble import ( "encoding/json" "fmt" - "github.com/jcelliott/lumber" "io/ioutil" "os" "path/filepath" "sync" + + "github.com/jcelliott/lumber" ) +// Version is the current version of the project const Version = "1.0.4" type ( - // + // Logger is a generic logger interface Logger interface { Fatal(string, ...interface{}) Error(string, ...interface{}) @@ -25,7 +27,7 @@ type ( Trace(string, ...interface{}) } - // a Driver is what is used to interact with the scribble database. It runs + // Driver is what is used to interact with the scribble database. It runs // transactions, and provides log output Driver struct { mutex sync.Mutex