Atlas48
/
scratch
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updating README

This commit is contained in:
Steve Domino 2015-11-21 10:32:17 -07:00
parent 9831494f39
commit 840fee7a1f
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -13,8 +13,8 @@ Install using `go get github.com/nanobox-io/golang-scribble`.
```go ```go
// a new scribble driver, providing the directory where it will be writing to, // a new scribble driver, providing the directory where it will be writing to,
// and a qualified logger to which it can send any output. // and a qualified logger if desired
db, err := scribble.New(dir, logger) db, err := scribble.New(dir, nil)
if err != nil { if err != nil {
fmt.Println("Error", err) fmt.Println("Error", err)
} }
@ -22,35 +22,32 @@ if err != nil {
// Write a fish to the database // Write a fish to the database
fish := Fish{} fish := Fish{}
if err := db.Write("fish", "onefish", fish); err != nil { if err := db.Write("fish", "onefish", fish); err != nil {
fmt.Println("Error", err)
} }
// Read all fish from the database // Read all fish from the database
fish := []Fish{} fish := []Fish{}
if err := db.Read("fish", "", fish); err != nil { if err := db.Read("fish", "", fish); err != nil {
fmt.Println("Error", err)
} }
// Read a fish from the database // Read a fish from the database
fish := Fish{} fish := Fish{}
if err := db.Read("fish", "onefish", fish); err != nil { if err := db.Read("fish", "onefish", fish); err != nil {
fmt.Println("Error", err)
} }
// Delete all fish from the database // Delete all fish from the database
if err := db.Delete("fish", ""); err != nil { if err := db.Delete("fish", ""); err != nil {
fmt.Println("Error", err)
} }
// Delete a fish from the database // Delete a fish from the database
if err := db.Delete("fish", "onefish"); err != nil { if err := db.Delete("fish", "onefish"); err != nil {
fmt.Println("Error", err)
} }
``` ```
For an example of a qualified logger see [here](http://godoc.org/github.com/nanobox-io/golang-hatchet).
## Documentation ## Documentation
Complete documentation is available on [godoc](http://godoc.org/github.com/nanobox-io/golang-scribble). Complete documentation is available on [godoc](http://godoc.org/github.com/nanobox-io/golang-scribble).