Skip to content

Commit 69ea83a

Browse files
committed
Update readme
1 parent 5571b94 commit 69ea83a

File tree

1 file changed

+10
-66
lines changed

1 file changed

+10
-66
lines changed

README.md

Lines changed: 10 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -11,72 +11,16 @@
1111

1212
RethinkDB adapter for [js-data](http://www.js-data.io/).
1313

14-
To get started, visit __[http://js-data.io](http://www.js-data.io)__.
14+
To get started, visit __[http://js-data.io](http://www.js-data.io/v3.0/docs/js-data-rethinkdb)__.
1515

16-
## Table of contents
16+
## Links
1717

18-
* [Quick start](#quick-start)
19-
* [Example App](#example-app)
20-
* [Guides and Tutorials](#guides-and-tutorials)
21-
* [API Reference Docs](#api-reference-docs)
22-
* [Community](#community)
23-
* [Support](#support)
24-
* [Contributing](#contributing)
25-
* [License](#license)
26-
27-
## Quick Start
28-
`npm install --save js-data js-data-rethinkdb rethinkdbdash`.
29-
30-
```js
31-
// Use Container instead of DataStore on the server
32-
import {Container} from 'js-data'
33-
import RethinkDBAdapter from 'js-data-rethinkdb'
34-
35-
// Create a store to hold your Mappers
36-
const store = new Container()
37-
38-
// Create an instance of RethinkDBAdapter with default settings
39-
const adapter = new RethinkDBAdapter()
40-
41-
// Mappers in "store" will use the RethinkDB adapter by default
42-
store.registerAdapter('rethinkdb', adapter, { default: true })
43-
44-
// Create a Mapper that maps to a "user" table
45-
store.defineMapper('user')
46-
```
47-
48-
```js
49-
async function findAllAdminUsers () {
50-
// Find all users where "user.role" == "admin"
51-
return await store.findAll('user', {
52-
role: 'admin'
53-
})
54-
}
55-
```
56-
57-
## Example App
58-
59-
[js-data-examples/server/rethinkdb](https://github.com/js-data/js-data-examples/tree/master/server/rethinkdb)
60-
61-
## Guides and Tutorials
62-
63-
[Get started at http://js-data.io](http://js-data.io)
64-
65-
## API Reference Docs
66-
67-
[Visit http://api.js-data.io](http://api.js-data.io).
68-
69-
## Community
70-
71-
[Explore the Community](http://js-data.io/docs/community).
72-
73-
## Support
74-
75-
[Find out how to Get Support](http://js-data.io/docs/support).
76-
77-
## Contributing
78-
79-
[Read the Contributing Guide](http://js-data.io/docs/contributing).
18+
* [Quick start](http://www.js-data.io/v3.0/docs/js-data-rethinkdb)
19+
* [Guides and Tutorials](http://www.js-data.io/v3.0/docs/home)
20+
* [API Reference Docs](http://api.js-data.io/js-data-rethinkdb)
21+
* [Community](http://js-data.io/docs/community)
22+
* [Support](http://js-data.io/docs/support)
23+
* [Contributing](http://js-data.io/docs/contributing)
8024

8125
## License
8226

@@ -96,7 +40,7 @@ Copyright (c) 2014-2016 js-data-rethinkdb project authors
9640
[circle_l]: https://circleci.com/gh/js-data/js-data-rethinkdb/tree/master
9741
[dn_b]: https://img.shields.io/npm/dm/js-data-rethinkdb.svg?style=flat
9842
[dn_l]: https://www.npmjs.org/package/js-data-rethinkdb
99-
[cov_b]: https://img.shields.io/coveralls/js-data/js-data-rethinkdb/master.svg?style=flat
100-
[cov_l]: https://coveralls.io/github/js-data/js-data-rethinkdb?branch=master
43+
[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-rethinkdb/v3.svg?style=flat
44+
[cov_l]: https://codecov.io/github/js-data/js-data-rethinkdb
10145
[cod_b]: https://img.shields.io/codacy/69206fcb0df6462ca559610af32fd1fb.svg
10246
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-rethinkdb/dashboard

0 commit comments

Comments
 (0)