|
2 | 2 |
|
3 | 3 | # js-data-rethinkdb |
4 | 4 |
|
5 | | -[![Slack Status][sl_b]][sl_l] |
6 | | -[![npm version][npm_b]][npm_l] |
7 | | -[![Circle CI][circle_b]][circle_l] |
8 | | -[![npm downloads][dn_b]][dn_l] |
9 | | -[![Coverage Status][cov_b]][cov_l] |
10 | | - |
11 | | -RethinkDB adapter for [js-data](http://www.js-data.io/). |
12 | | - |
13 | | -To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-rethinkdb)__. |
14 | | - |
15 | | -## Links |
16 | | - |
17 | | -* [Quick start](http://www.js-data.io/docs/home#quick-start) - Get started in 5 minutes |
18 | | -* [Guides and Tutorials](http://www.js-data.io/docs/home) - Learn how to use JSData |
19 | | -* [`RethinkDBAdapter` Guide](http://www.js-data.io/docs/js-data-rethinkdb) - Learn how to use `RethinkDBAdapter` |
20 | | -* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc. |
21 | | -* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community |
22 | | -* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward |
23 | | - * [Contributing to js-data-rethinkdb](https://github.com/js-data/js-data-rethinkdb/blob/master/.github/CONTRIBUTING.md) |
24 | | - |
25 | | -## License |
26 | | - |
27 | | -The MIT License (MIT) |
28 | | - |
29 | | -Copyright (c) 2014-2016 js-data-rethinkdb project authors |
30 | | - |
31 | | -* [LICENSE](https://github.com/js-data/js-data-rethinkdb/blob/master/LICENSE) |
32 | | -* [AUTHORS](https://github.com/js-data/js-data-rethinkdb/blob/master/AUTHORS) |
33 | | -* [CONTRIBUTORS](https://github.com/js-data/js-data-rethinkdb/blob/master/CONTRIBUTORS) |
34 | | - |
35 | | -[sl_b]: http://slack.js-data.io/badge.svg |
36 | | -[sl_l]: http://slack.js-data.io |
37 | | -[npm_b]: https://img.shields.io/npm/v/js-data-rethinkdb.svg?style=flat |
38 | | -[npm_l]: https://www.npmjs.org/package/js-data-rethinkdb |
39 | | -[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb.svg?style=flat |
40 | | -[circle_l]: https://circleci.com/gh/js-data/js-data-rethinkdb |
41 | | -[dn_b]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat |
42 | | -[dn_l]: https://www.npmjs.org/package/js-data-rethinkdb |
43 | | -[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb.svg?style=flat |
44 | | -[cov_l]: https://codecov.io/github/js-data/js-data-rethinkdb |
| 5 | +[![Slack][1]][2] |
| 6 | +[![NPM][3]][4] |
| 7 | +[![Tests][5]][6] |
| 8 | +[![Downloads][7]][8] |
| 9 | +[![Coverage][9]][10] |
| 10 | + |
| 11 | +RethinkDB adapter for the [JSData Node.js ORM][11]. |
| 12 | + |
| 13 | +### Installation |
| 14 | + |
| 15 | + npm install --save js-data js-data-rethinkdb |
| 16 | + |
| 17 | +### Usage |
| 18 | + |
| 19 | +```js |
| 20 | +import { RethinkDBAdapter } from 'js-data-rethinkdb'; |
| 21 | + |
| 22 | +// Create an instance of RethinkDBAdapter |
| 23 | +const adapter = new RethinkDBAdapter(); |
| 24 | + |
| 25 | +// Other JSData setup hidden |
| 26 | + |
| 27 | +// Register the adapter instance |
| 28 | +store.registerAdapter('rethinkdb', adapter, { default: true }); |
| 29 | +``` |
| 30 | + |
| 31 | +### JSData + RethinkDB Tutorial |
| 32 | + |
| 33 | +Start with the [JSData + RethinkDB tutorial][12] or checkout the [API Reference Documentation][13]. |
| 34 | + |
| 35 | +### Need help? |
| 36 | + |
| 37 | +Please [post a question][14] on Stack Overflow. **This is the preferred method.** |
| 38 | + |
| 39 | +You can also chat with folks on the [Slack Channel][15]. If you end up getting |
| 40 | +your question answered, please still consider consider posting your question to |
| 41 | +Stack Overflow (then possibly answering it yourself). Thanks! |
| 42 | + |
| 43 | +### Want to contribute? |
| 44 | + |
| 45 | +Awesome! You can get started over at the [Contributing guide][16]. |
| 46 | + |
| 47 | +Thank you! |
| 48 | + |
| 49 | +### License |
| 50 | + |
| 51 | +[The MIT License (MIT)][17] |
| 52 | + |
| 53 | +Copyright (c) 2014-2017 [js-data-rethinkdb project authors][18] |
| 54 | + |
| 55 | +[1]: http://slack.js-data.io/badge.svg |
| 56 | +[2]: http://slack.js-data.io |
| 57 | +[3]: https://img.shields.io/npm/v/js-data-rethinkdb.svg?style=flat |
| 58 | +[4]: https://www.npmjs.org/package/js-data-rethinkdb |
| 59 | +[5]: https://img.shields.io/circleci/project/js-data/js-data-rethinkdb.svg?style=flat |
| 60 | +[6]: https://circleci.com/gh/js-data/js-data-rethinkdb |
| 61 | +[7]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat |
| 62 | +[8]: https://www.npmjs.org/package/js-data-rethinkdb |
| 63 | +[9]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb.svg?style=flat |
| 64 | +[10]: https://codecov.io/github/js-data/js-data-rethinkdb |
| 65 | +[11]: http://www.js-data.io/ |
| 66 | +[12]: http://www.js-data.io/docs/js-data-rethinkdb |
| 67 | +[13]: http://api.js-data.io/js-data-rethinkdb |
| 68 | +[14]: http://stackoverflow.com/questions/tagged/jsdata |
| 69 | +[15]: http://slack.js-data.io/ |
| 70 | +[16]: https://github.com/js-data/js-data-rethinkdb/blob/master/.github/CONTRIBUTING.md |
| 71 | +[17]: https://github.com/js-data/js-data-rethinkdb/blob/master/LICENSE |
| 72 | +[18]: https://github.com/js-data/js-data-rethinkdb/blob/master/AUTHORS |
0 commit comments