Skip to content

Commit a7ba7f7

Browse files
committed
Update docs.
1 parent d14bd42 commit a7ba7f7

File tree

3 files changed

+58
-46
lines changed

3 files changed

+58
-46
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
(delete this line) Find out how to get help here: http://js-data.io/docs/community.
1+
## Description
22

3-
<your detailed, actionable, and helpful text goes here>
3+
<description>
4+
5+
## Steps to reproduce
6+
7+
<steps_to_reproduce>
48

59
Thanks!

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
22

3-
- [ ] - `npm test` succeeds
4-
- [ ] - Code coverage does not decrease (if any source code was changed)
5-
- [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
6-
- [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)
3+
- [ ] - If applicable, appropriate JSDoc comments were updated in source code
4+
- [ ] - If applicable, approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)

README.md

Lines changed: 50 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,53 @@
22

33
# js-data-mongodb
44

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-
MongoDB 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-mongodb)__.
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-
* [`MongoDBAdapter` Guide](http://www.js-data.io/docs/js-data-mongodb) - Learn how to use `MongoDBAdapter`
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-mongodb](https://github.com/js-data/js-data-mongodb/blob/master/.github/CONTRIBUTING.md)
24-
25-
## License
26-
27-
The MIT License (MIT)
28-
29-
Copyright (c) 2014-2016 js-data-mongodb project authors
30-
31-
* [LICENSE](https://github.com/js-data/js-data-mongodb/blob/master/LICENSE)
32-
* [AUTHORS](https://github.com/js-data/js-data-mongodb/blob/master/AUTHORS)
33-
* [CONTRIBUTORS](https://github.com/js-data/js-data-mongodb/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-mongodb.svg?style=flat
38-
[npm_l]: https://www.npmjs.org/package/js-data-mongodb
39-
[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-mongodb.svg?style=flat
40-
[circle_l]: https://circleci.com/gh/js-data/js-data-mongodb
41-
[dn_b]: https://img.shields.io/npm/dm/js-data-mongodb.svg?style=flat
42-
[dn_l]: https://www.npmjs.org/package/js-data-mongodb
43-
[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-mongodb.svg?style=flat
44-
[cov_l]: https://codecov.io/github/js-data/js-data-mongodb
5+
[![Slack][1]][2]
6+
[![NPM][3]][4]
7+
[![Tests][5]][6]
8+
[![Downloads][7]][8]
9+
[![Coverage][9]][10]
10+
11+
A MongoDB adapter for the [JSData Node.js ORM][11].
12+
13+
### Just getting started?
14+
15+
Start with the [JSData + MongoDB tutorial][12] or checkout the [API Reference Documentation][13].
16+
17+
### Need help?
18+
19+
Please [post a question][14] on Stack Overflow. **This is the preferred method.**
20+
21+
You can also chat with folks on the [Slack Channel][15]. If you end up getting
22+
your question answered, please still consider consider posting your question to
23+
Stack Overflow (then possibly answering it yourself). Thanks!
24+
25+
### Want to contribute?
26+
27+
Awesome! You can get started over at the [Contributing guide][16].
28+
29+
Thank you!
30+
31+
### License
32+
33+
[The MIT License (MIT)][17]
34+
35+
Copyright (c) 2014-2016 [js-data-mongodb project authors][18]
36+
37+
[1]: http://slack.js-data.io/badge.svg
38+
[2]: http://slack.js-data.io
39+
[3]: https://img.shields.io/npm/v/js-data-mongodb.svg?style=flat
40+
[4]: https://www.npmjs.org/package/js-data-mongodb
41+
[5]: https://img.shields.io/circleci/project/js-data/js-data-mongodb.svg?style=flat
42+
[6]: https://circleci.com/gh/js-data/js-data-mongodb
43+
[7]: https://img.shields.io/npm/dm/js-data-mongodb.svg?style=flat
44+
[8]: https://www.npmjs.org/package/js-data-mongodb
45+
[9]: https://img.shields.io/codecov/c/github/js-data/js-data-mongodb.svg?style=flat
46+
[10]: https://codecov.io/github/js-data/js-data-mongodb
47+
[11]: http://www.js-data.io/
48+
[12]: http://www.js-data.io/v3.0/docs/js-data-mongodb
49+
[13]: http://api.js-data.io/js-data-mongodb
50+
[14]: http://stackoverflow.com/questions/tagged/jsdata
51+
[15]: http://slack.js-data.io/
52+
[16]: https://github.com/js-data/js-data-mongodb/blob/master/.github/CONTRIBUTING.md
53+
[17]: https://github.com/js-data/js-data-mongodb/blob/master/LICENSE
54+
[18]: https://github.com/js-data/js-data-mongodb/blob/master/AUTHORS

0 commit comments

Comments
 (0)