Stable Version 3.0.0-alpha.1

Author: jmdobry

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

.bowerrc

@@ -9,4 +9,5 @@ coverage/
 
 npm-debug.log
 junit/
-dist/karma.start.js
+dist/karma.start.js
+doc/

.gitignore

@@ -20,17 +20,15 @@ bower_components/
 
 *.iml
 .idea/
-
+bs.jpg
 *.png
 CONTRIBUTING.md
 favicon.ico
 circle.yml
 bower.json
-.bowerrc
-Gruntfile.js
 *.start.js
 karma.conf.js
 test/
-lib/
 src/
-junit/
+junit/
+doc/

.npmignore

@@ -1,24 +1,46 @@
 # Contributing Guide
 
-First, support is handled via the [Slack Channel](http://slack.js-data.io) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
+## Support
 
-When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
+Support questions are handled via [StackOverflow][so], [Slack][slack], and the
+[Mailing List][ml]. Ask your questions there.
 
-- good - Your versions of js-data, js-data-localstorage, etc., relevant console logs/error, code examples that revealed the issue
-- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
-- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
+## Community
+- [StackOverflow Channel][so]
+- [Slack Chat][slack] [![Slack Status][sl_b]][slack]
+- [Announcements](http://www.js-data.io/blog)
+- [Mailing List](ml)
+- [Issues Tracker](https://github.com/js-data/js-data/issues)
+- [GitHub](https://github.com/js-data/js-data)
+- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md)
 
-[Github Issues](https://github.com/js-data/js-data-localstorage/issues).
+## Contributing
 
-#### Submitting Pull Requests
+When submitting bug reports or feature requests on GitHub, please include _as
+much detail as possible_.
 
-1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
-1. Fork js-data-localstorage
+- good - Your versions of Angular, JSData, etc, relevant console logs, stack
+traces, code examples that revealed the issue, etc.
+- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
+[bin](http://jsbin.com/?html,output) that demonstrates the issue
+- best - A Pull Request that fixes the issue, including test coverage for the
+issue and the fix
+
+### Pull Requests
+
+1. Contribute to the issue/discussion that is the reason you'll be developing in
+the first place
+1. Fork js-data
 1. `git clone [email protected]:<you>/js-data-localstorage.git`
 1. `cd js-data-localstorage; npm install;`
 1. Write your code, including relevant documentation and tests
 1. Run `npm test` (build and test)
 1. Your code will be linted and checked for formatting, the tests will be run
-1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
+1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
+will be committed when a release is cut.
 1. Submit your PR and we'll review!
 1. Thanks!
+
+[slack]: http://slack.js-data.io
+[ml]: https://groups.io/org/groupsio/jsdata
+[so]: http://stackoverflow.com/questions/tagged/jsdata

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Jason Dobry
+Copyright (c) 2014-2016 Jason Dobry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,30 +1,43 @@
-<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="64" height="64" />
+<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="96" height="96" />
 
-## js-data-localstorage [![Slack Status][sl_b]][sl_l] [![npm version][npm_b]][npm_l] [![Circle CI][circle_b]][circle_l] [![npm downloads][dn_b]][dn_l] [![Coverage Status][cov_b]][cov_l] [![Codacy][cod_b]][cod_l]
+# js-data-localstorage
+
+[![Slack Status][sl_b]][sl_l]
+[![npm version][npm_b]][npm_l]
+[![Circle CI][circle_b]][circle_l]
+[![npm downloads][dn_b]][dn_l]
+[![Coverage Status][cov_b]][cov_l]
+[![Codacy][cod_b]][cod_l]
 
 localStorage adapter for [js-data](http://www.js-data.io/).
 
 Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using
 <img src="https://raw.githubusercontent.com/js-data/js-data-localstorage/master/bs.jpg" alt="bs logo" title="browserstack" width="150" height="35" style="vertical-align: middle" />
 
-### API Documentation
-[DSLocalStorageAdapter](http://www.js-data.io/docs/dslocalstorageadapter)
+## Table of contents
 
-### Demo
-[https://js-data-localstorage.firebaseapp.com/](https://js-data-localstorage.firebaseapp.com/)
+* [Quick start](#quick-start)
+* [Documentation](#documentation)
+* [API Reference](#api-reference)
+* [Demo](#demo)
+* [Support](#support)
+* [Community](#community)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Quick Start
 
-### Quick Start
 `npm install --save js-data js-data-localstorage` or `bower install --save js-data js-data-localstorage`.
 
 Load `js-data-localstorage.js` after `js-data.js`.
 
 ```js
-var adapter = new DSLocalStorageAdapter();
+var adapter = new LocalStorageAdapter();
 
-var store = new JSData.DS();
+var store = new JSData.DataStore();
 store.registerAdapter('localstorage', adapter, { default: true });
 
-// "store" will now use the localstorage adapter for all async operations
+// "store" will now use the localstorage adapter
 ```
 
 You can also provide a custom storage medium (it just needs to implement the `localStorage` API):
@@ -33,7 +46,7 @@ You can also provide a custom storage medium (it just needs to implement the `lo
 var memory = {};
 
 // Turn js-data-localstorage into an in-memory adapter
-var memoryAdapter = new DSLocalStorageAdapter({
+var memoryAdapter = new LocalStorageAdapter({
   storage: {
     getItem: function (key) {
       return memory[key];
@@ -48,52 +61,69 @@ var memoryAdapter = new DSLocalStorageAdapter({
 });
 
 // Turn js-data-localstorage into a sessionStorage adapter
-var sessionAdapter = new DSLocalStorageAdapter({
+var sessionAdapter = new LocalStorageAdapter({
   storage: sessionStorage
 });
 ```
 
-### Changelog
-[CHANGELOG.md](https://github.com/js-data/js-data-localstorage/blob/master/CHANGELOG.md)
+## Documentation
+- [Getting Started with js-data](http://www.js-data.io/docs/home)
+- [js-data-http](http://www.js-data.io/docs/js-data-localstorage)
+- [CHANGELOG.md](https://github.com/js-data/js-data-localstorage/blob/master/CHANGELOG.md)
 
-### Community
-- [Slack Channel][sl_l] - Better than IRC!
-- [Announcements](http://www.js-data.io/blog)
-- [Mailing List](https://groups.io/org/groupsio/jsdata) - Ask your questions!
-- [Issues](https://github.com/js-data/js-data-localstorage/issues) - Found a bug? Feature request? Submit an issue!
-- [GitHub](https://github.com/js-data/js-data-localstorage) - View the source code for js-data.
-- [Contributing Guide](https://github.com/js-data/js-data-localstorage/blob/master/CONTRIBUTING.md)
+## API Reference
+- [js-data](http://api.js-data.io/js-data/)
+- [js-data-localstorage](http://api.js-data.io/js-data-localstorage/)
 
-### Contributing
+## Demo
+[https://js-data-localstorage.firebaseapp.com/](https://js-data-localstorage.firebaseapp.com/)
+
+## Support
 
-First, support is handled via the [Slack Channel][sl_l] and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
+Support questions are handled via [StackOverflow][so], [Slack][slack], and the
+[Mailing List][ml]. Ask your questions there.
+
+## Community
+- [StackOverflow Channel][so]
+- [Slack Chat][slack] [![Slack Status][sl_b]][slack]
+- [Announcements](http://www.js-data.io/blog)
+- [Mailing List](ml)
+- [Issues Tracker](https://github.com/js-data/js-data/issues)
+- [GitHub](https://github.com/js-data/js-data)
+- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md)
 
-When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
+## Contributing
 
-- good - Your versions of js-data, js-data-localstorage, etc., relevant console logs/error, code examples that revealed the issue
-- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
-- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
+When submitting bug reports or feature requests on GitHub, please include _as
+much detail as possible_.
 
-[Github Issues](https://github.com/js-data/js-data-localstorage/issues).
+- good - Your versions of Angular, JSData, etc, relevant console logs, stack
+traces, code examples that revealed the issue, etc.
+- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
+[bin](http://jsbin.com/?html,output) that demonstrates the issue
+- best - A Pull Request that fixes the issue, including test coverage for the
+issue and the fix
 
-#### Submitting Pull Requests
+### Pull Requests
 
-1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
-1. Fork js-data-localstorage
+1. Contribute to the issue/discussion that is the reason you'll be developing in
+the first place
+1. Fork js-data
 1. `git clone [email protected]:<you>/js-data-localstorage.git`
 1. `cd js-data-localstorage; npm install;`
 1. Write your code, including relevant documentation and tests
 1. Run `npm test` (build and test)
 1. Your code will be linted and checked for formatting, the tests will be run
-1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
+1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
+will be committed when a release is cut.
 1. Submit your PR and we'll review!
 1. Thanks!
 
-### License
+## License
 
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Jason Dobry
+Copyright (c) 2014-2016 Jason Dobry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -125,3 +155,4 @@ SOFTWARE.
 [cov_l]: https://coveralls.io/github/js-data/js-data-localstorage?branch=master
 [cod_b]: https://img.shields.io/codacy/b8e46008e6ad45159b7a6927dbfd66c3.svg
 [cod_l]: https://www.codacy.com/app/jasondobry/js-data-localstorage/dashboard
+[so]: http://stackoverflow.com/questions/tagged/jsdata

README.md

@@ -1,7 +1,7 @@
 {
   "name": "js-data-localstorage",
   "description": "localStorage adapter for js-data.",
-  "homepage": "http://www.js-data.io/docs/dslocalstorageadapter",
+  "homepage": "http://www.js-data.io/docs/js-data-localstorage",
   "repository": {
     "type": "git",
     "url": "https://github.com/js-data/js-data-localstorage.git"
@@ -17,18 +17,16 @@
     ".*",
     "*.iml",
     "src/",
-    "lib/",
     "doc/",
-    "guide/",
+    "junit/",
     "coverage/",
-    "Gruntfile.js",
     "node_modules/",
     "test/",
     "package.json",
     "karma.conf.js",
     "karma.start.js"
   ],
   "dependencies": {
-    "js-data": "~2.x"
+    "js-data": "~3.x"
   }
 }

bower.json

@@ -0,0 +1,23 @@
+  {
+  "source": {
+    "includePattern": ".*js$"
+  },
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "template": "./node_modules/ink-docstrap/template",
+    "destination": "./doc/",
+    "recurse": true,
+    "verbose": true,
+    "readme": "./README.md",
+    "package": "./package.json"
+  },
+  "templates": {
+    "theme": "lumen",
+    "systemName": "js-data-localstorage",
+    "copyright": "js-data-localstorage Copyright © 2014-2016 Jason Dobry",
+    "outputSourceFiles": true,
+    "syntaxTheme": "dark",
+    "linenums": true,
+    "footer": "<div style=\"text-align:center\">Back to <a href=\"http://js-data.io\">js-data.io</a></div>"
+  }
+}