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-http [ ![ Slack Status] [ sl_b ]] [ sl_l ] [ ![ npm version] [ npm_b ]] [ npm_l ] [ ![ Circle CI] [ circle_b ]] [ circle_l ] [ ![ npm downloads] [ dn_b ]] [ dn_l ] [ ![ Coverage Status] [ cov_b ]] [ cov_l ] [ ![ Codacy] [ cod_b ]] [ cod_l ]
3
+ # js-data-http
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
HTTP adapter for [ js-data] ( http://www.js-data.io/ ) .
6
13
7
- ### API Documentation
8
- [ DSHttpAdapter] ( http://www.js-data.io/docs/dshttpadapter )
14
+ To get started, visit __ [ http://js-data.io ] ( http://www.js-data.io ) __ .
15
+
16
+ ## Table of contents
17
+
18
+ * [ Quick start] ( #quick-start )
19
+ * [ Guides and Tutorials] ( #guides-and-tutorials )
20
+ * [ API Reference Docs] ( #api-reference-docs )
21
+ * [ Community] ( #community )
22
+ * [ Support] ( #support )
23
+ * [ Contributing] ( #contributing )
24
+ * [ License] ( #license )
9
25
10
- ### Quick Start
26
+ ## Quick Start
11
27
` npm install --save js-data js-data-http ` or ` bower install --save js-data js-data-http ` .
12
28
13
29
Load ` js-data-http.js ` after ` js-data.js ` .
@@ -21,65 +37,35 @@ store.registerAdapter('http', adapter, { default: true });
21
37
// "store" will now use the http adapter for all async operations
22
38
```
23
39
24
- ### Changelog
25
- [ CHANGELOG.md] ( https://github.com/js-data/js-data-http/blob/master/CHANGELOG.md )
40
+ ## Guides and Tutorials
26
41
27
- ### Community
28
- - [ Slack Channel] [ sl_l ] - Better than IRC!
29
- - [ Announcements] ( http://www.js-data.io/blog )
30
- - [ Mailing List] ( https://groups.io/org/groupsio/jsdata ) - Ask your questions!
31
- - [ Issues] ( https://github.com/js-data/js-data-http/issues ) - Found a bug? Feature request? Submit an issue!
32
- - [ GitHub] ( https://github.com/js-data/js-data-http ) - View the source code for js-data.
33
- - [ Contributing Guide] ( https://github.com/js-data/js-data-http/blob/master/CONTRIBUTING.md )
42
+ [ Get started at http://js-data.io ] ( http://js-data.io )
34
43
35
- ### Contributing
44
+ ## API Reference Docs
36
45
37
- First, support is handled via the [ Slack Channel ] [ sl_l ] and the [ Mailing List ] ( https ://groups.io/org/groupsio/jsdata ) . Ask your questions there .
46
+ [ Visit http ://api.js-data.io ] ( http://api.js-data.io ) .
38
47
39
- When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
48
+ ## Community
40
49
41
- - good - Your versions of js-data, js-data-http, etc., relevant console logs/error, code examples that revealed the issue
42
- - better - A [ plnkr] ( http://plnkr.co/ ) , [ fiddle] ( http://jsfiddle.net/ ) , or [ bin] ( http://jsbin.com/?html,output ) that demonstrates the issue
43
- - best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
50
+ [ Explore the Community] ( http://js-data.io/docs/community ) .
44
51
45
- [ Github Issues ] ( https://github.com/js-data/js-data-http/issues ) .
52
+ ## Support
46
53
47
- #### Submitting Pull Requests
54
+ [ Find out how to Get Support ] ( http://js-data.io/docs/support ) .
48
55
49
- 1 . Contribute to the issue/discussion that is the reason you'll be developing in the first place
50
- 1 . Fork js-data-http
51
- 1 . ` git clone [email protected] :<you>/js-data-http.git `
52
- 1 . ` cd js-data-http; npm install; `
53
- 1 . Write your code, including relevant documentation and tests
54
- 1 . Run ` npm test ` (build and test)
55
- 1 . Your code will be linted and checked for formatting, the tests will be run
56
- 1 . The ` dist/ ` folder & files will be generated, do NOT commit ` dist/* ` ! They will be committed when a release is cut.
57
- 1 . Submit your PR and we'll review!
58
- 1 . Thanks!
56
+ ## Contributing
59
57
60
- ### License
58
+ [ Read the Contributing Guide] ( http://js-data.io/docs/contributing ) .
59
+
60
+ ## License
61
61
62
62
The MIT License (MIT)
63
63
64
- Copyright (c) 2014-2015 Jason Dobry
65
-
66
- Permission is hereby granted, free of charge, to any person obtaining a copy
67
- of this software and associated documentation files (the "Software"), to deal
68
- in the Software without restriction, including without limitation the rights
69
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
70
- copies of the Software, and to permit persons to whom the Software is
71
- furnished to do so, subject to the following conditions:
72
-
73
- The above copyright notice and this permission notice shall be included in all
74
- copies or substantial portions of the Software.
75
-
76
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
77
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
78
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
79
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
80
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
81
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
82
- SOFTWARE.
64
+ Copyright (c) 2014-2016 js-data-http project authors
65
+
66
+ * [ LICENSE] ( https://github.com/js-data/js-data-http/blob/master/LICENSE )
67
+ * [ AUTHORS] ( https://github.com/js-data/js-data-http/blob/master/AUTHORS )
68
+ * [ CONTRIBUTORS] ( https://github.com/js-data/js-data-http/blob/master/CONTRIBUTORS )
83
69
84
70
[ sl_b ] : http://slack.js-data.io/badge.svg
85
71
[ sl_l ] : http://slack.js-data.io
0 commit comments