coolaj86
/
json-storage.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

clarified README

This commit is contained in:
AJ ONeal 2012-03-02 11:51:58 -07:00
parent 3ddf2be63d
commit dfe7ca8752
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,7 +1,7 @@
jsonStorage JsonStorage
==== ====
A light abstraction for DOMStorage (such as localStorage). A light, sensible, abstraction for DOMStorage (such as localStorage).
Installation Installation
=== ===
@ -34,16 +34,16 @@ Made fo for Node.JS and Ender.JS (browser-side).
API API
=== ===
* `create(DOMStorage, namespace)` * `JsonStorage.create(DOMStorage, namespace)`
* `DOMStorage` should be globalStorage, sessionStorage, or localStorage * `DOMStorage` should be globalStorage, sessionStorage, or localStorage
* `namespace` is optional string which allows multiple non-conflicting storage containers * `namespace` is optional string which allows multiple non-conflicting storage containers
* `get(key)` * `store.get(key)`
* `set(key, value)` * `store.set(key, value)`
* `remove(key)` * `store.remove(key)`
* `clear()` * `store.clear()`
* `keys()` * `store.keys()`
* `size()` * `store.size()`
* `toJSON()` * `store.toJSON()`
* `JSON.stringify(store)` * `JSON.stringify(store)`
Upgrading from localStorage and 1.0.x to 1.1.x Upgrading from localStorage and 1.0.x to 1.1.x