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 " />
22
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
44
5- HTTP adapter for [ js-data] ( http://www.js-data.io/ ) .
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 ]
611
7- The ` js-data-http ` npm package is for use in the Browser, and the ` js-data-http-node `
8- package is for use in Node.js.
12+ This repo contains HTTP adapters for [ js-data] ( http://www.js-data.io/ ) :
913
10- ### API Documentation
11- [ DSHttpAdapter] ( http://www.js-data.io/docs/dshttpadapter )
14+ - js-data-http - HTTP (XHR, includes [ axios] [ axios ] ) adapter for js-data in the
15+ browser. Capable of using ` window.fetch ` instead of axios.
16+ - js-data-fetch - Same as js-data-http but doesn't include axios and will use
17+ ` window.fetch ` if available and if you don't provide your own http library.
18+ - js-data-http-node - Same as js-data-http but runs on Node.js. Depends on axios
19+ and will use axios unless you provide a different http library.
1220
13- ### Quick Start
21+ Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using
22+ <img src =" https://raw.githubusercontent.com/js-data/js-data-localstorage/master/bs.jpg " alt =" bs logo " title =" browserstack " width =" 150 " height =" 35 " style =" vertical-align : middle " />
23+
24+ ## Table of contents
25+
26+ * [ Quick start] ( #quick-start )
27+ * [ Dependencies] ( #dependencies )
28+ * [ Documentation] ( #documentation )
29+ * [ API Reference] ( #api-reference )
30+ * [ Support] ( #support )
31+ * [ Community] ( #community )
32+ * [ Contributing] ( #contributing )
33+ * [ License] ( #license )
34+
35+ ## Quick Start
1436
1537#### Browser
1638
@@ -83,18 +105,37 @@ var Student = Base.extend({}, { name: 'Student' })
83105// "School" and "Student" will now use the http adapter by default
84106```
85107
86- ### Changelog
87- [ CHANGELOG.md] ( https://github.com/js-data/js-data-http/blob/master/CHANGELOG.md )
108+ ## Dependencies
109+
110+ ` js-data-http ` bundles axios and depends on ` js-data ` . ` js-data-fetch ` depends
111+ on ` js-data ` . ` js-data-http-node ` depends on ` js-data ` and optionally axios.
112+
113+ See [ JSData's dependencies] ( https://github.com/js-data/js-data/blob/master/README.md#dependencies ) .
114+
115+ ## Documentation
116+ - [ Getting Started with js-data] ( http://www.js-data.io/docs/home )
117+ - [ js-data-http] ( http://www.js-data.io/docs/js-data-http )
118+ - [ CHANGELOG.md] ( https://github.com/js-data/js-data-http/blob/master/CHANGELOG.md )
88119
89- ### Community
90- - [ Slack Channel] [ sl_l ] - Better than IRC!
120+ ## API Reference
121+ - [ DS] ( http://www.js-data.io/docs/ds )
122+ - [ DSHttpAdapter] ( http://www.js-data.io/docs/dshttpadapter )
123+
124+ ## Support
125+
126+ Support questions are handled via [ Stack Overflow] [ so ] , [ Slack] [ sl_l ] , and the
127+ [ Mailing List] [ ml ] . Ask your questions there.
128+
129+ ## Community
130+ - [ Stack Overflow] [ so ]
131+ - [ Slack chat] [ sl_l ]
91132- [ Announcements] ( http://www.js-data.io/blog )
92- - [ Mailing List] ( https://groups.io/org/groupsio/jsdata ) - Ask your questions!
93- - [ Issues ] ( https://github.com/js-data/js-data-http/issues ) - Found a bug? Feature request? Submit an issue!
94- - [ GitHub] ( https://github.com/js-data/js-data-http ) - View the source code for js-data.
133+ - [ Mailing List] [ ml ]
134+ - [ Issue Tracker ] ( https://github.com/js-data/js-data-http/issues )
135+ - [ GitHub] ( https://github.com/js-data/js-data-http )
95136- [ Contributing Guide] ( https://github.com/js-data/js-data-http/blob/master/CONTRIBUTING.md )
96137
97- ### Contributing
138+ ## Contributing
98139
99140First, support is handled via the [ Slack Channel] [ sl_l ] and the
100141[ Mailing List] [ ml ] . Ask your questions there.
@@ -109,15 +150,13 @@ code examples that revealed the issue
109150- best - A Pull Request that fixes the issue, including test coverage for the
110151issue and the fix
111152
112- [ Github Issues] ( https://github.com/js-data/js-data/issues ) .
113-
114153#### Pull Requests
115154
1161551 . Contribute to the issue/discussion that is the reason you'll be developing in
117156the first place
1181571 . Fork js-data-http
1191581 . ` git clone git@github.com:<you>/js-data-http.git `
120- 1 . ` cd js-data-http; npm install; bower install; `
159+ 1 . ` cd js-data-http; npm install; `
1211601 . Write your code, including relevant documentation and tests
1221611 . Run ` npm test ` (build and test)
1231621 . Your code will be linted and checked for formatting, the tests will be run
@@ -130,7 +169,7 @@ will be committed when a release is cut.
130169
131170The MIT License (MIT)
132171
133- Copyright (c) 2014-2015 Jason Dobry
172+ Copyright (c) 2014-2016 Jason Dobry
134173
135174Permission is hereby granted, free of charge, to any person obtaining a copy
136175of this software and associated documentation files (the "Software"), to deal
@@ -152,6 +191,7 @@ SOFTWARE.
152191
153192[ sl_b ] : http://slack.js-data.io/badge.svg
154193[ sl_l ] : http://slack.js-data.io
194+ [ so ] : http://stackoverflow.com/questions/tagged/jsdata
155195[ npm_b ] : https://img.shields.io/npm/v/js-data-http.svg?style=flat
156196[ npm_l ] : https://www.npmjs.org/package/js-data-http
157197[ circle_b ] : https://img.shields.io/circleci/project/js-data/js-data-http/master.svg?style=flat
@@ -162,4 +202,5 @@ SOFTWARE.
162202[ cov_l ] : https://coveralls.io/github/js-data/js-data-http?branch=master
163203[ cod_b ] : https://img.shields.io/codacy/3931bbd8d838463297f70640aa78251b.svg
164204[ cod_l ] : https://www.codacy.com/app/jasondobry/js-data-http/dashboard
165-
205+ [ axios ] : https://github.com/mzabriskie/axios
206+ [ ml ] : https://groups.io/org/groupsio/jsdata
0 commit comments