Prepare for 3.0.0-beta.1

Author: jmdobry

.github/CONTRIBUTING.md

@@ -1,27 +1,36 @@
-# Contributing
+# Contributing to js-data-firebase
 
-[Read the Contributing Guide](http://js-data.io/docs/contributing).
+[Read the general Contributing Guide](http://js-data.io/docs/contributing).
 
-## Support
+## Project structure
 
-[Find out how to Get Support](http://js-data.io/docs/support).
+* `dist/` - Contains final build files for distribution
+* `doc/` - Output folder for JSDocs
+* `src/` - Project source code
+* `test/` - Project tests
 
-## Community
+## Clone, build & test
 
-[Explore the Community](http://js-data.io/docs/community).
+1. `clone [email protected]:js-data/js-data-firebase.git`
+1. `cd js-data-firebase`
+1. `npm install`
+1. `npm test` - Lint, build, and test
 
-### Have write access?
-
-To cut a release:
+## To cut a release
 
 1. Checkout master
 1. Bump version in `package.json` appropriately
-1. Run `npm run release`
 1. Update `CHANGELOG.md` appropriately
-1. Commit and push changes, including the `dist/` folder
+1. Run `npm run release`
+1. Commit and push changes
+1. Checkout `release`, merge `master` into `release`
+1. Run `npm run release` again
+1. Commit and push changes
 1. Make a GitHub release
+  - tag from `release` branch
   - set tag name to version
   - set release name to version
   - set release body to changelog entry for the version
-  - attach the files in the `dist/` folder
 1. `npm publish .`
+
+See also [Community & Support](http://js-data.io/docs/community).

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,5 @@
-(delete this line) GitHub Issues are NOT for support questions.
-(delete this line) GitHub Issues ARE for bug reports, feature requests, and other issues.
-(delete this line) Find out how to Get Support here: http://js-data.io/docs/support.
+(delete this line) Find out how to get help here: http://js-data.io/docs/community.
 
-<your detailed, discussable, actionable, and helpful text goes here>
+<your detailed, actionable, and helpful text goes here>
 
 Thanks!

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,6 @@
 Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
 
 - [ ] - `npm test` succeeds
-- [ ] - Pull request has been squashed into 1 commit
-- [ ] - I did NOT commit changes to `dist/`
 - [ ] - Code coverage does not decrease (if any source code was changed)
 - [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
 - [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)

.gitignore

@@ -11,4 +11,5 @@ npm-debug.log
 junit/
 dist/karma.start.js
 doc/
-typings/
+typings/
+.vscode

.vscode/launch.json

@@ -6,6 +6,5 @@
 #   # commits  Name or Organization <email address>
 # The email address is not required for organizations.
 Jason Dobry <[email protected]>
-Jason Dobry <[email protected]>
 Overall, Matthew <[email protected]>
 Tianxiang Chen <[email protected]>

.vscode/settings.json

@@ -1,5 +1,36 @@
-##### 3.0.0-alpha.1 - 05 May 2016
-- Alpha Version 3.0.0-alpha.1
+##### 3.0.0-beta.1 - 03 May 2016
+
+Official v3 beta release
+
+###### Breaking changes
+- Now depends on js-data v3
+- How you must now import in ES2015:
+
+    ```js
+    import FirebaseAdapter from 'js-data-firebase'
+    const adapter = new FirebaseAdapter({ basePath: '<your-firebase-url>' })
+    ```
+    or
+    ```js
+    import {FirebaseAdapter, version} from 'js-data-firebase'
+    console.log(version)
+    const adapter = new FirebaseAdapter()
+    ```
+
+- How you must now import in ES5:
+
+    ```js
+    var JSDataFirebase = require('js-data-firebase')
+    var FirebaseAdapter = JSDataFirebase.FirebaseAdapter
+    var adapter = new FirebaseAdapter({ basePath: '<your-firebase-url>' })
+    ```
+
+- Moved some `dist` files to `release` to reduce noise
+
+###### Other
+- Upgraded dependencies
+- Improved JSDoc comments
+- Now using js-data JSDoc template
 
 ##### 2.1.1 - 10 July 2015
 

AUTHORS

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

CHANGELOG.md

@@ -1,104 +1,47 @@
-<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-firebase [![bower version](https://img.shields.io/bower/v/js-data-firebase.svg?style=flat-square)](https://www.npmjs.org/package/js-data-firebase) [![npm version](https://img.shields.io/npm/v/js-data-firebase.svg?style=flat-square)](https://www.npmjs.org/package/js-data-firebase) [![Circle CI](https://img.shields.io/circleci/project/js-data/js-data-firebase/master.svg?style=flat-square)](https://circleci.com/gh/js-data/js-data-firebase/tree/master) [![npm downloads](https://img.shields.io/npm/dm/js-data-firebase.svg?style=flat-square)](https://www.npmjs.org/package/js-data-firebase) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/js-data/js-data-firebase/blob/master/LICENSE)
+# js-data-firebase
 
-Firebase adapter for [js-data](http://www.js-data.io/).
-
-### API Documentation
-[FirebaseAdapter](http://www.js-data.io/docs/firebaseadapter)
-
-### Demos
-[js-data-firebase + Angular](https://js-data-firebase.firebaseapp.com/angular/)
-
-[js-data-firebase + React](https://js-data-firebase.firebaseapp.com/react/)
-
-[js-data-firebase + Riot](https://js-data-firebase.firebaseapp.com/riot/)
-
-### Project Status
-
-__Latest Release:__ [![Latest Release](https://img.shields.io/github/release/js-data/js-data-firebase.svg?style=flat-square)](https://github.com/js-data/js-data-firebase/releases)
-
-__Status:__
-
-[![Dependency Status](https://img.shields.io/gemnasium/js-data/js-data-firebase.svg?style=flat-square)](https://gemnasium.com/js-data/js-data-firebase) [![Coverage Status](https://img.shields.io/coveralls/js-data/js-data-firebase/master.svg?style=flat-square)](https://coveralls.io/r/js-data/js-data-firebase?branch=master) [![Codacity](https://img.shields.io/codacy/47f0a155f0de4a74b951103a4578353f.svg?style=flat-square)](https://www.codacy.com/public/jasondobry/js-data-firebase/dashboard)
-
-__Supported Platforms:__
-
-[![browsers](https://img.shields.io/badge/Browser-Chrome%2CFirefox%2CSafari%2COpera%2CIE%209%2B%2CiOS%20Safari%207.1%2B%2CAndroid%20Browser%202.3%2B-green.svg?style=flat-square)](https://github.com/js-data/js-data)
-
-### Quick Start
-`bower install --save js-data js-data-firebase` or `npm install --save js-data js-data-firebase`.
-
-Load `firebase.js`.
+[![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]
 
-Load `js-data-firebase.js` after `js-data.js`.
-
-```js
-var adapter = new FirebaseAdapter({
-  basePath: 'https://my-app.firebase.io'
-});
-
-var store = new JSData.DS();
-
-store.registerAdapter('firebase', adapter, { default: true });
-
-// "store" will now use the firebase adapter for all async operations
-```
-
-### Changelog
-[CHANGELOG.md](https://github.com/js-data/js-data-firebase/blob/master/CHANGELOG.md)
-
-### Community
-- [Gitter Channel](https://gitter.im/js-data/js-data) - 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-firebase/issues) - Found a bug? Feature request? Submit an issue!
-- [GitHub](https://github.com/js-data/js-data-firebase) - View the source code for js-data.
-- [Contributing Guide](https://github.com/js-data/js-data-firebase/blob/master/CONTRIBUTING.md)
-
-### Contributing
-
-First, support is handled via the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
-
-When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
+Firebase adapter for [js-data](http://www.js-data.io/).
 
-- good - Your versions of js-data, js-data-firebase, 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
+To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-firebase)__.
 
-[Github Issues](https://github.com/js-data/js-data-firebase/issues).
+Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using
+<img src="https://raw.githubusercontent.com/js-data/js-data-firebase/master/bs.jpg" alt="bs logo" title="browserstack" width="150" height="35" style="vertical-align: middle" />
 
-#### Pull Requests
+## Links
 
-1. Contribute to the issue that is the reason you'll be developing in the first place
-1. Fork js-data-firebase
-1. `git clone https://github.com/<you>/js-data-firebase.git`
-1. `cd js-data-firebase; npm install; bower install;`
-1. `grunt go` (builds and starts a watch)
-1. (in another terminal) `grunt karma:dev` (runs the tests)
-1. Write your code, including relevant documentation and tests
-1. Submit a PR and we'll review
+* [Quick start](http://www.js-data.io/docs/home#quick-start) - Get started in 5 minutes
+* [Guides and Tutorials](http://www.js-data.io/docs/home) - Learn how to use JSData
+* [`FirebaseAdapter` Guide](http://www.js-data.io/docs/js-data-firebase) - Learn how to use `FirebaseAdapter`
+* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc.
+* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community
+* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward
+  * [Contributing to js-data-firebase](https://github.com/js-data/js-data-firebase/blob/master/.github/CONTRIBUTING.md)
 
-### License
+## License
 
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 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
-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.
+Copyright (c) 2014-2016 js-data-firebase project authors
+
+* [LICENSE](https://github.com/js-data/js-data-firebase/blob/master/LICENSE)
+* [AUTHORS](https://github.com/js-data/js-data-firebase/blob/master/AUTHORS)
+* [CONTRIBUTORS](https://github.com/js-data/js-data-firebase/blob/master/CONTRIBUTORS)
+
+[sl_b]: http://slack.js-data.io/badge.svg
+[sl_l]: http://slack.js-data.io
+[npm_b]: https://img.shields.io/npm/v/js-data-firebase.svg?style=flat
+[npm_l]: https://www.npmjs.org/package/js-data-firebase
+[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-firebase.svg?style=flat
+[circle_l]: https://circleci.com/gh/js-data/js-data-firebase
+[dn_b]: https://img.shields.io/npm/dm/js-data-firebase.svg?style=flat
+[dn_l]: https://www.npmjs.org/package/js-data-firebase
+[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-firebase.svg?style=flat
+[cov_l]: https://codecov.io/github/js-data/js-data-firebase