You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 lines
2.3 KiB
71 lines
2.3 KiB
12 years ago
|
# Backbone localStorage Adapter v1.0
|
||
|
|
|
||
|
|
[](http://travis-ci.org/jeromegn/Backbone.localStorage)
|
||
|
|
|
||
|
|
Quite simply a localStorage adapter for Backbone. It's a drop-in replacement for Backbone.Sync() to handle saving to a localStorage database.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Include Backbone.localStorage after having included Backbone.js:
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script type="text/javascript" src="backbone.js"></script>
|
||
|
|
<script type="text/javascript" src="backbone.localStorage.js"></script>
|
||
|
|
```
|
||
|
|
|
||
|
|
Create your collections like so:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
window.SomeCollection = Backbone.Collection.extend({
|
||
|
|
|
||
|
|
localStorage: new Backbone.LocalStorage("SomeCollection"), // Unique name within your app.
|
||
|
|
|
||
|
|
// ... everything else is normal.
|
||
|
|
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
Feel free to use Backbone as you usually would, this is a drop-in replacement.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
You'll need node and to `npm install` before being able to run the minification script.
|
||
|
|
|
||
|
|
1. Fork;
|
||
|
|
2. Write code;
|
||
|
|
3. Write tests (or vice et versa);
|
||
|
|
4. `make test`;
|
||
|
|
5. `make minified`;
|
||
|
|
6. Create a pull request.
|
||
|
|
|
||
|
|
Have fun!
|
||
|
|
|
||
|
|
## Credits
|
||
|
|
|
||
|
|
Thanks to [Mark Woodall](https://github.com/llad) for the QUnit tests.
|
||
|
|
Thanks to [Martin Häcker](https://github.com/dwt) for the many fixes and the test isolation.
|
||
|
|
|
||
|
|
## Licensed
|
||
|
|
|
||
|
|
Licensed under MIT license
|
||
|
|
|
||
|
|
Copyright (c) 2010 Jerome Gravel-Niquet
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
||
|
|
a copy of this software and associated documentation files (the
|
||
|
|
"Software"), to deal in the Software without restriction, including
|
||
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
||
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||
|
|
permit persons to whom the Software is furnished to do so, subject to
|
||
|
|
the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be
|
||
|
|
included in all copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||
|
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||
|
|
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||
|
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||
|
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|