Merge pull request #25 from js-data/v3

V3

.github/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing to js-data-firebase
+
+[Read the general Contributing Guide](http://js-data.io/docs/contributing).
+
+## Project structure
+
+* `dist/` - Contains final build files for distribution
+* `doc/` - Output folder for JSDocs
+* `src/` - Project source code
+* `test/` - Project tests
+
+## Clone, build & test
+
+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
+
+## To cut a release
+
+1. Checkout master
+1. Bump version in `package.json` appropriately
+1. Update `CHANGELOG.md` appropriately
+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
+1. `npm publish .`
+
+See also [Community & Support](http://js-data.io/docs/community).

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,5 @@
+(delete this line) Find out how to get help here: http://js-data.io/docs/community.
+
+<your detailed, actionable, and helpful text goes here>
+
+Thanks!

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
+
+- [ ] - `npm test` succeeds
+- [ ] - 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

@@ -6,3 +6,10 @@ bower_components/
 *.iml
 
 coverage/
+
+npm-debug.log
+junit/
+dist/karma.start.js
+doc/
+typings/
+.vscode

.mailmap

@@ -0,0 +1 @@
+Jason Dobry <[email protected]> Jason Dobry <[email protected]>

AUTHORS

@@ -0,0 +1,10 @@
+# This is the official list of js-data-firebase project authors.
+#
+# This file is controlled by scripts/authors.js
+#
+# Names are formatted as:
+#   # commits  Name or Organization <email address>
+# The email address is not required for organizations.
+Jason Dobry <[email protected]>
+Overall, Matthew <[email protected]>
+Tianxiang Chen <[email protected]>

CHANGELOG.md

@@ -1,3 +1,37 @@
+##### 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
 
 ###### Backwards compatible bug fixes

CONTRIBUTORS

@@ -0,0 +1,7 @@
+# People who have contributed to the js-data-firebase project.
+#
+# This file is controlled by scripts/authors.js
+#
+# Names should be added to this file as:
+#   [commit count] Name <email address>
+    63	Jason Dobry <[email protected]>

LICENSE

@@ -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