1
- <img src =" https://raw.githubusercontent.com/js-data/js-data/master/js-data.png " alt =" js-data logo " title =" js-data " align =" right " width =" 64 " height =" 64 " />
1
+ <img src =" https://raw.githubusercontent.com/js-data/js-data/master/js-data.png " alt =" js-data logo " title =" js-data " align =" right " width =" 96 " height =" 96 " />
2
2
3
- ## js-data-mongodb [ ![ npm version] ( https://img.shields.io/npm/v/js-data-mongodb.svg?style=flat-square )] ( https://www.npmjs.org/package/js-data-mongodb ) [ ![ Circle CI] ( https://img.shields.io/circleci/project/js-data/js-data-mongodb/master.svg?style=flat-square )] ( https://circleci.com/gh/js-data/js-data-mongodb/tree/master ) [ ![ npm downloads] ( https://img.shields.io/npm/dm/js-data-mongodb.svg?style=flat-square )] ( https://www.npmjs.org/package/js-data-mongodb ) [ ![ License] ( https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square )] ( https://github.com/js-data/js-data-mongodb/blob/master/LICENSE )
3
+ # js-data-mongodb
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
+ [ ![ Codacy] [ cod_b ]] [ cod_l ]
4
11
5
12
MongoDB adapter for [ js-data] ( http://www.js-data.io/ ) .
6
13
7
- ### API Documentation
14
+ ## API Documentation
8
15
[ DSMongoDBAdapter] ( http://www.js-data.io/docs/dsmongodbadapter )
9
16
10
- ### Project Status
11
-
12
- __ Latest Release:__ [ ![ Latest Release] ( https://img.shields.io/github/release/js-data/js-data-mongodb.svg?style=flat-square )] ( https://github.com/js-data/js-data-mongodb/releases )
13
-
14
- __ Status:__
15
-
16
- [ ![ Dependency Status] ( https://img.shields.io/gemnasium/js-data/js-data-mongodb.svg?style=flat-square )] ( https://gemnasium.com/js-data/js-data-mongodb ) [ ![ Codacity] ( https://img.shields.io/codacy/1f45ede49dfb4bdea68f46ca55631968.svg?style=flat-square )] ( https://www.codacy.com/public/jasondobry/js-data-mongodb/dashboard )
17
-
18
- __ Supported Platforms:__
19
-
20
- [ ![ node version] ( https://img.shields.io/badge/Node-0.10%2B-green.svg?style=flat-square )] ( https://github.com/js-data/js-data )
21
-
22
- ### Quick Start
17
+ ## Quick Start
23
18
` npm install --save js-data js-data-mongodb ` .
24
19
25
20
``` js
@@ -41,60 +36,46 @@ var User = store.defineResource({
41
36
});
42
37
```
43
38
44
- ### Changelog
45
- [ CHANGELOG.md] ( https://github.com/js-data/js-data-mongodb/blob/master/CHANGELOG.md )
39
+ ## Changelog
40
+ See [ CHANGELOG.md] ( https://github.com/js-data/js-data-mongodb/blob/master/CHANGELOG.md ) .
46
41
47
- ### Community
48
- - [ Gitter Channel] ( https://gitter.im/js-data/js-data ) - Better than IRC!
42
+ ## Community
43
+ - [ StackOverflow Channel] [ so ]
44
+ - [ Slack Chat] [ sl_l ] [ ![ Slack Status] [ sl_b ]] [ sl_l ]
49
45
- [ Announcements] ( http://www.js-data.io/blog )
50
- - [ Mailing List] ( https://groups.io/org/groupsio/jsdata ) - Ask your questions!
51
- - [ Issues] ( https://github.com/js-data/js-data-mongodb/issues ) - Found a bug? Feature request? Submit an issue!
52
- - [ GitHub] ( https://github.com/js-data/js-data-mongodb ) - View the source code for js-data.
53
- - [ Contributing Guide] ( https://github.com/js-data/js-data-mongodb/blob/master/CONTRIBUTING.md )
54
-
55
- ### Contributing
56
-
57
- First, support is handled via the [ Mailing List] ( https://groups.io/org/groupsio/jsdata ) . Ask your questions there.
46
+ - [ Mailing List] ( ml )
47
+ - [ Issue Tracker] ( https://github.com/js-data/js-data-mongodb/issues )
58
48
59
- When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
49
+ ## Support
60
50
61
- - good - Your versions of js-data, js-data-mongodb, etc., relevant console logs/error, code examples that revealed the issue
62
- - better - A [ plnkr] ( http://plnkr.co/ ) , [ fiddle] ( http://jsfiddle.net/ ) , or [ bin] ( http://jsbin.com/?html,output ) that demonstrates the issue
63
- - best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
51
+ Support questions are handled via [ StackOverflow] [ so ] , [ Slack] [ sl_l ] , and the
52
+ [ Mailing List] [ ml ] . Ask your questions there.
64
53
65
- [ Github Issues] ( https://github.com/js-data/js-data-mongodb/issues ) .
54
+ When submitting bug reports on GitHub, please include as much detail as possible
55
+ to make debugging quick and easy.
66
56
67
- #### Pull Requests
57
+ ## Contributing
68
58
69
- 1 . Contribute to the issue that is the reason you'll be developing in the first place
70
- 1 . Fork js-data-mongodb
71
- 1 . ` git clone https://github.com/<you>/js-data-mongodb.git `
72
- 1 . ` cd js-data-mongodb; npm install; bower install; `
73
- 1 . ` grunt go ` (builds and starts a watch)
74
- 1 . (in another terminal) ` grunt karma:dev ` (runs the tests)
75
- 1 . Write your code, including relevant documentation and tests
76
- 1 . Submit a PR and we'll review
59
+ See [ CONTRIBUTING.md] ( https://github.com/js-data/js-data-mongodb/blob/master/CONTRIBUTING.md ) .
77
60
78
- ### License
61
+ ## License
79
62
80
63
The MIT License (MIT)
81
64
82
- Copyright (c) 2014-2015 Jason Dobry
83
-
84
- Permission is hereby granted, free of charge, to any person obtaining a copy
85
- of this software and associated documentation files (the "Software"), to deal
86
- in the Software without restriction, including without limitation the rights
87
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
88
- copies of the Software, and to permit persons to whom the Software is
89
- furnished to do so, subject to the following conditions:
90
-
91
- The above copyright notice and this permission notice shall be included in all
92
- copies or substantial portions of the Software.
93
-
94
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
95
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
96
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
97
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
98
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
99
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
100
- SOFTWARE.
65
+ See [ LICENSE] ( https://github.com/js-data/js-data-mongodb/blob/master/LICENSE ) .
66
+
67
+ [ sl_b ] : http://slack.js-data.io/badge.svg
68
+ [ sl_l ] : http://slack.js-data.io
69
+ [ npm_b ] : https://img.shields.io/npm/v/js-data-mongodb.svg?style=flat
70
+ [ npm_l ] : https://www.npmjs.org/package/js-data-mongodb
71
+ [ circle_b ] : https://img.shields.io/circleci/project/js-data/js-data-mongodb/master.svg?style=flat
72
+ [ circle_l ] : https://circleci.com/gh/js-data/js-data-mongodb/tree/master
73
+ [ dn_b ] : https://img.shields.io/npm/dm/js-data-mongodb.svg?style=flat
74
+ [ dn_l ] : https://www.npmjs.org/package/js-data-mongodb
75
+ [ cov_b ] : https://img.shields.io/coveralls/js-data/js-data-mongodb/master.svg?style=flat
76
+ [ cov_l ] : https://coveralls.io/github/js-data/js-data-mongodb?branch=master
77
+ [ cod_b ] : https://img.shields.io/codacy/1f45ede49dfb4bdea68f46ca55631968.svg
78
+ [ cod_l ] : https://www.codacy.com/app/jasondobry/js-data-mongodb/dashboard
79
+
80
+ [ ml ] : https://groups.io/org/groupsio/jsdata
81
+ [ so ] : http://stackoverflow.com/questions/tagged/jsdata
0 commit comments