3.0.0 (#36)

Author: jmdobry

.babelrc

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

CHANGELOG.md

@@ -1,3 +1,7 @@
+##### 3.0.0 - 23 August 2017
+
+Stable 3.0.0 release
+
 ##### 3.0.0-rc.1 - 11 December 2016
 
 - Updated dependencies

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2016 js-data-firebase project authors
+Copyright (c) 2014-2017 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

README.md

@@ -2,46 +2,104 @@
 
 # js-data-firebase
 
-[![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]
-
-Firebase adapter for [js-data](http://www.js-data.io/).
-
-To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-firebase)__.
+[![Slack][1]][2]
+[![NPM][3]][4]
+[![Tests][5]][6]
+[![Downloads][7]][8]
+[![Coverage][9]][10]
 
 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" />
 
-## Links
+A Firebase adapter for the [JSData Node.js ORM][11].
+
+### Installation
+
+    npm install --save js-data js-data-firebase firebase
+
+### Usage (Browser)
+
+```js
+import { FirebaseAdapter } from 'js-data-firebase';
+
+window.firebase.initializeApp({
+  apiKey: window.API_KEY,
+  authDomain: window.AUTH_DOMAIN,
+  databaseURL: window.DATABASE_URL
+});
+
+// Create an instance of FirebaseAdapter
+const adapter = new FirebaseAdapter({
+  db: window.firebase.database()
+});
+
+// Other JSData setup hidden
+
+// Register the adapter instance
+store.registerAdapter('firebase', adapter, { default: true });
+```
+
+### Usage (Node.js)
+
+```js
+import firebase from 'firebase';
+import { FirebaseAdapter } from 'js-data-firebase';
+
+firebase.initializeApp({
+  databaseURL: process.env.DATABASE_URL,
+  serviceAccount: process.env.KEY_FILENAME || 'key.json'
+});
+
+// Create an instance of FirebaseAdapter
+const adapter = new FirebaseAdapter({
+  db: firebase.database()
+});
+
+// Other JSData setup hidden
+
+// Register the adapter instance
+store.registerAdapter('firebase', adapter, { default: true });
+```
+
+### JSData + Firebase Tutorial
+
+Start with the [JSData + Firebase tutorial][12] or checkout the [API Reference Documentation][13].
+
+### Need help?
+
+Please [post a question][14] on Stack Overflow. **This is the preferred method.**
+
+You can also chat with folks on the [Slack Channel][15]. If you end up getting
+your question answered, please still consider consider posting your question to
+Stack Overflow (then possibly answering it yourself). Thanks!
+
+### Want to contribute?
 
-* [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)
+Awesome! You can get started over at the [Contributing guide][16].
 
-## License
+Thank you!
 
-The MIT License (MIT)
+### License
 
-Copyright (c) 2014-2016 js-data-firebase project authors
+[The MIT License (MIT)][17]
 
-* [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)
+Copyright (c) 2014-2017 [js-data-firebase project authors][18]
 
-[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
+[1]: http://slack.js-data.io/badge.svg
+[2]: http://slack.js-data.io
+[3]: https://img.shields.io/npm/v/js-data-firebase.svg?style=flat
+[4]: https://www.npmjs.org/package/js-data-firebase
+[5]: https://img.shields.io/circleci/project/js-data/js-data-firebase.svg?style=flat
+[6]: https://circleci.com/gh/js-data/js-data-firebase
+[7]: https://img.shields.io/npm/dm/js-data-firebase.svg?style=flat
+[8]: https://www.npmjs.org/package/js-data-firebase
+[9]: https://img.shields.io/codecov/c/github/js-data/js-data-firebase.svg?style=flat
+[10]: https://codecov.io/github/js-data/js-data-firebase
+[11]: http://www.js-data.io/
+[12]: http://www.js-data.io/docs/js-data-firebase
+[13]: http://api.js-data.io/js-data-firebase
+[14]: http://stackoverflow.com/questions/tagged/jsdata
+[15]: http://slack.js-data.io/
+[16]: https://github.com/js-data/js-data-firebase/blob/master/.github/CONTRIBUTING.md
+[17]: https://github.com/js-data/js-data-firebase/blob/master/LICENSE
+[18]: https://github.com/js-data/js-data-firebase/blob/master/AUTHORS

circle.yml

@@ -4,18 +4,17 @@ general:
       - gh-pages
 machine:
   node:
-    version: 5.7.0
+    version: 6.11.2
 dependencies:
   pre:
     - npm i -g npm
     - npm i -g nyc codecov
-    - npm i js-data@^3.0.0-beta.6 firebase
 test:
   pre:
     - echo $KARMA_CONFIG > config.js
     - echo $KEYFILE > key.json
   post:
-    - nyc report --reporter=lcov | codecov
+    - nyc report --reporter=lcov > coverage.lcov && codecov
 general:
   artifacts:
     - "dist"

conf.json

@@ -14,7 +14,7 @@
   "templates": {
     "theme": "jsdata",
     "systemName": "js-data-firebase",
-    "copyright": "js-data-firebase Copyright © 2014-2016 js-data-firebase project authors",
+    "copyright": "js-data-firebase Copyright © 2014-2017 js-data-firebase project authors",
     "outputSourceFiles": true,
     "linenums": true,
     "footer": "<div style=\"text-align:center\"><a href=\"/\">api.js-data.io</a>&nbsp;&#8226;&nbsp;<a href=\"http://js-data.io\">js-data.io</a></div>",