From dfe7ca875292e8ce31a107e2802573a4683ac988 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 2 Mar 2012 11:51:58 -0700 Subject: [PATCH] clarified README --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7f05300..154b70a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -jsonStorage +JsonStorage ==== -A light abstraction for DOMStorage (such as localStorage). +A light, sensible, abstraction for DOMStorage (such as localStorage). Installation === @@ -34,16 +34,16 @@ Made fo for Node.JS and Ender.JS (browser-side). API === - * `create(DOMStorage, namespace)` + * `JsonStorage.create(DOMStorage, namespace)` * `DOMStorage` should be globalStorage, sessionStorage, or localStorage * `namespace` is optional string which allows multiple non-conflicting storage containers - * `get(key)` - * `set(key, value)` - * `remove(key)` - * `clear()` - * `keys()` - * `size()` - * `toJSON()` + * `store.get(key)` + * `store.set(key, value)` + * `store.remove(key)` + * `store.clear()` + * `store.keys()` + * `store.size()` + * `store.toJSON()` * `JSON.stringify(store)` Upgrading from localStorage and 1.0.x to 1.1.x