cargo/README.md

HTML5 web storage module

# cargo
#### HTML5 [web storage API](http://www.w3.org/TR/webstorage/) JavaScript module

- Abstracts the native storage APIs into a simple intuitive interface
- Uses native `localStorage` and `sessionStorage` [where available](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#Browser_compatibility)
- Gracefully degrades to [temporary](#storage-duration) storage
- Works standalone or with build tools like [browserify](https://www.npmjs.org/package/browserify) or [ender](https://www.npmjs.org/package/ender)

## API ([0.8](../../releases))

### `cargo.local()`
- `cargo.local(key?, value?)`
  - `cargo.local()` get all
  - `cargo.local(key)` get 
  - `cargo.local(key, value)` set 
  - `cargo.local(key, undefined)` remove
- `cargo.local.get(key)`
- `cargo.local.set(key, value)`
- `cargo.local.remove(key)`

### `cargo.session()`
- `cargo.session(key?, value?)`
  - `cargo.session()` get all
  - `cargo.session(key)` get 
  - `cargo.session(key, value)` set 
  - `cargo.session(key, undefined)` remove
- `cargo.session.get(key)`
- `cargo.session.set(key, value)`
- `cargo.session.remove(key)`

### `cargo.temp()`
- `cargo.temp(key?, value?)`
  - `cargo.temp()` get all
  - `cargo.temp(key)` get 
  - `cargo.temp(key, value)` set 
  - `cargo.temp(key, undefined)` remove
- `cargo.temp.get(key)`
- `cargo.temp.set(key, value)`
- `cargo.temp.remove(key)`

## Storage duration
- [<b>local</b>](http://www.w3.org/TR/webstorage/#the-localstorage-attribute) storage stores for unlimited browser sessions
- [<b>session</b>](http://www.w3.org/TR/webstorage/#the-sessionstorage-attribute) storage stores for the current browser session
- <b>temp</b> storage stores until the user refreshes or closes the current page

## Fund
Support this project by [tipping the developer](https://www.gittip.com/ryanve/) <samp><b>=)</b></samp>

## License
MIT