Merge pull request #20 from js-data/v3

V3

Author: jmdobry

.github/CONTRIBUTING.md

@@ -1,27 +1,37 @@
-# Contributing
+# Contributing to js-data-rethinkdb
 
-[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-rethinkdb.git`
+1. `cd js-data-rethinkdb`
+1. `npm install`
+1. `npm run build` - Lint and build distribution files
+1. `npm run mocha` - Run tests (RethinkDB must be running)
 
-### 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)

.npmignore

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

AUTHORS

@@ -1,3 +1,118 @@
+##### 3.0.0-beta.2 - 29 April 2016
+
+###### Breaking changes
+- How you must now import in ES2015:
+
+    ```js
+    import RethinkDBAdapter from 'js-data-rethinkdb'
+    const adapter = new RethinkDBAdapter()
+    ```
+    or
+    ```js
+    import {RethinkDBAdapter, version} from 'js-data-rethinkdb'
+    console.log(version)
+    const adapter = new RethinkDBAdapter()
+    ```
+
+- How you must now import in ES5:
+
+    ```js
+    var JSDataRethinkDB = require('js-data-rethinkdb')
+    var RethinkDBAdapter = JSDataRethinkDB.RethinkDBAdapter
+    var adapter = new RethinkDBAdapter()
+    ```
+
+- `OPERATORS` is now an export, not a static property of the `RethinkDBAdapter` class.
+
+###### Other
+- Upgraded dependencies
+- Improved JSDoc comments
+- Now using js-data JSDoc template
+
+##### 3.0.0-beta.1 - 17 April 2016
+
+Official v3 beta release
+
+###### Other
+- Upgraded dependencies
+
+##### 3.0.0-alpha.13 - 17 March 2016
+
+###### Backwards incompatible API changes
+- Added sum and count methods
+
+##### 3.0.0-alpha.12 - 10 March 2016
+
+###### Other
+- Moved more common adapter functionality into js-data-adapter
+
+##### 3.0.0-alpha.11 - 06 March 2016
+
+###### Backwards compatible bug fixes
+- create() now makes use of withoutRelations()
+- More use of Adapter#respond() more consistent
+
+##### 3.0.0-alpha.10 - 06 March 2016
+
+###### Backwards compatible API changes
+- Now making use of makeHasManyForeignKeys
+
+##### 3.0.0-alpha.9 - 06 March 2016
+
+###### Other
+- Upgraded js-data-adapter
+
+##### 3.0.0-alpha.8 - 06 March 2016
+
+###### Other
+- Extracted common adapter functionality into js-data-adapter
+- Extracted common js-data repo utility scripts into js-data-repo-tools
+
+##### 3.0.0-alpha.7 - 03 March 2016
+
+###### Backwards compatible API changes
+- Added RethinkDBAdapter.extend
+
+##### 3.0.0-alpha.6 - 01 March 2016
+
+###### Backwards compatible bug fixes
+- Couple of fixes based on the latest js-data-adapter-tests
+
+##### 3.0.0-alpha.5 - 27 February 2016
+
+###### Backwards compatible API changes
+- Added ability to override query operators used by RethinkDBAdapter#filterSequence.
+
+###### Other
+- Improved JSDoc comments.
+
+##### 3.0.0-alpha.4 - 26 February 2016
+
+###### Other
+- Finished JSDoc comments
+
+##### 3.0.0-alpha.3 - 26 February 2016
+
+###### Backwards compatible API changes
+- Removed returnDeletedIds option
+- Added insertOpts, updateOpts, deleteOpts, and runOpts options
+
+##### 3.0.0-alpha.2 - 26 February 2016
+
+###### Backwards compatible bug fixes
+- Fixed edge case with returnDeletedIds
+
+##### 3.0.0-alpha.1 - 26 February 2016
+
+###### Breaking API changes
+- Now depends on js-data 3.x
+- Now longer uses internal `defaults` property, settings are on the adapter instance itself
+
+###### Backwards compatible API changes
+- Added createMany and updateMany methods
+- Added lifecycle hooks for all methods
+- Added contains, notContains, |contains, and |notContains operators
+
 ##### 2.2.0 - 25 February 2016
 
 ###### Other

CHANGELOG.md

@@ -1,9 +1,8 @@
-# People who have contributed to the js-data-rethinkdb project.
+# This is the official list of js-data-rethinkdb project contributors.
 #
-# This file is controlled by scripts/authors.js
+# Names are formatted as:
+#   Name <email address>
 #
-# Names should be added to this file as:
-#   [commit count] Name <email address>
-     1	InternalFX <[email protected]>
-    39	Jason Dobry <[email protected]>
-     2	Ollie Relph <[email protected]>
+InternalFX <[email protected]>
+Jason Dobry <[email protected]>
+Ollie Relph <[email protected]>

CONTRIBUTORS

@@ -7,64 +7,20 @@
 [![Circle CI][circle_b]][circle_l]
 [![npm downloads][dn_b]][dn_l]
 [![Coverage Status][cov_b]][cov_l]
-[![Codacy][cod_b]][cod_l]
 
 RethinkDB adapter for [js-data](http://www.js-data.io/).
 
-To get started, visit __[http://js-data.io](http://www.js-data.io)__.
+To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-rethinkdb)__.
 
-## Table of contents
+## Links
 
-* [Quick start](#quick-start)
-* [Example App](#example-app)
-* [Guides and Tutorials](#guides-and-tutorials)
-* [API Reference Docs](#api-reference-docs)
-* [Community](#community)
-* [Support](#support)
-* [Contributing](#contributing)
-* [License](#license)
-
-## Quick Start
-`npm install --save js-data js-data-rethinkdb`.
-
-```js
-var JSData = require('js-data');
-var RethinkDBAdapter = require('js-data-rethinkdb');
-
-var store = new JSData.DS();
-var adapter = new RethinkDBAdapter();
-
-// "store" will now use the RethinkDB adapter for all async operations
-store.registerAdapter('rethinkdb', adapter, { default: true });
-
-var User = store.defineResource({
-  name: 'user'
-});
-```
-
-## Example App
-
-[js-data-examples/server/rethinkdb](https://github.com/js-data/js-data-examples/tree/master/server/rethinkdb)
-
-## Guides and Tutorials
-
-[Get started at http://js-data.io](http://js-data.io)
-
-## API Reference Docs
-
-[Visit http://api.js-data.io](http://api.js-data.io).
-
-## Community
-
-[Explore the Community](http://js-data.io/docs/community).
-
-## Support
-
-[Find out how to Get Support](http://js-data.io/docs/support).
-
-## Contributing
-
-[Read the Contributing Guide](http://js-data.io/docs/contributing).
+* [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
+* [`RethinkDBAdapter` Guide](http://www.js-data.io/docs/js-data-rethinkdb) - Learn how to use `RethinkDBAdapter`
+* [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-rethinkdb](https://github.com/js-data/js-data-rethinkdb/blob/master/.github/CONTRIBUTING.md)
 
 ## License
 
@@ -80,11 +36,9 @@ Copyright (c) 2014-2016 js-data-rethinkdb project authors
 [sl_l]: http://slack.js-data.io
 [npm_b]: https://img.shields.io/npm/v/js-data-rethinkdb.svg?style=flat
 [npm_l]: https://www.npmjs.org/package/js-data-rethinkdb
-[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb/master.svg?style=flat
-[circle_l]: https://circleci.com/gh/js-data/js-data-rethinkdb/tree/master
+[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb.svg?style=flat
+[circle_l]: https://circleci.com/gh/js-data/js-data-rethinkdb
 [dn_b]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat
 [dn_l]: https://www.npmjs.org/package/js-data-rethinkdb
-[cov_b]: https://img.shields.io/coveralls/js-data/js-data-rethinkdb/master.svg?style=flat
-[cov_l]: https://coveralls.io/github/js-data/js-data-rethinkdb?branch=master
-[cod_b]: https://img.shields.io/codacy/69206fcb0df6462ca559610af32fd1fb.svg
-[cod_l]: https://www.codacy.com/app/jasondobry/js-data-rethinkdb/dashboard
+[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb.svg?style=flat
+[cov_l]: https://codecov.io/github/js-data/js-data-rethinkdb

README.md

@@ -12,12 +12,15 @@
     "package": "./package.json"
   },
   "templates": {
-    "theme": "lumen",
+    "theme": "jsdata",
     "systemName": "js-data-rethinkdb",
     "copyright": "js-data-rethinkdb Copyright © 2014-2016 js-data-rethinkdb project authors",
     "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>"
+    "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>",
+    "analytics": {
+      "ua": "UA-55528236-2",
+      "domain": "api.js-data.io"
+    }
   }
 }