From cffdb3f127ba43ea458991405b39f52bd49be583 Mon Sep 17 00:00:00 2001 From: Steve Domino Date: Thu, 17 Dec 2015 17:13:27 -0700 Subject: [PATCH] updating readme to match how scribble actually works; there was a refactor not long ago and the readme never was updated. bump to 1.0.4 --- README.md | 21 +++++++++++++-------- scribble.go | 2 +- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5cccd8e..fe2c90f 100644 --- a/README.md +++ b/README.md @@ -25,20 +25,20 @@ if err := db.Write("fish", "onefish", fish); err != nil { fmt.Println("Error", err) } -// Read all fish from the database +// Read a fish from the database (passing fish by reference) fish := []Fish{} -if err := db.Read("fish", "", fish); err != nil { +if err := db.Read("fish", "onefish", &fish); err != nil { fmt.Println("Error", err) } -// Read a fish from the database -fish := Fish{} -if err := db.Read("fish", "onefish", fish); err != nil { +// Read all fish from the database, unmarshaling the response. +records, err := db.ReadAll("fish") +if err != nil { fmt.Println("Error", err) } -// Delete all fish from the database -if err := db.Delete("fish", ""); err != nil { +fish := []Fish{} +if err := json.Unmarhsal(records, &fish); err != nil { fmt.Println("Error", err) } @@ -46,6 +46,11 @@ if err := db.Delete("fish", ""); err != nil { if err := db.Delete("fish", "onefish"); err != nil { fmt.Println("Error", err) } + +// Delete all fish from the database +if err := db.Delete("fish", ""); err != nil { + fmt.Println("Error", err) +} ``` ## Documentation @@ -57,7 +62,7 @@ Complete documentation is available on [godoc](http://godoc.org/github.com/nanob - Better support for concurrency - Better support for sub collections - More methods to allow different types of reads/writes -- More tests (you can never have enough) +- More tests (you can never have enough!) ## Contributing diff --git a/scribble.go b/scribble.go index 10d05aa..06c90cf 100644 --- a/scribble.go +++ b/scribble.go @@ -11,7 +11,7 @@ import ( "sync" ) -const Version = "1.0.3" +const Version = "1.0.4" type (