Skip to content

Commit 94901c9

Browse files
committed
Initial commit.
1 parent 01a2aed commit 94901c9

15 files changed

+1489
-191
lines changed

.babelrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"presets": ["es2015-rollup"]
3+
}

.github/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
[Read the Contributing Guide](http://js-data.io/docs/contributing).
4+
5+
## Support
6+
7+
[Find out how to Get Support](http://js-data.io/docs/support).
8+
9+
## Community
10+
11+
[Explore the Community](http://js-data.io/docs/community).
12+
13+
### Have write access?
14+
15+
To cut a release:
16+
17+
1. Checkout master
18+
1. Bump version in `package.json` appropriately
19+
1. Run `npm run release`
20+
1. Update `CHANGELOG.md` appropriately
21+
1. Commit and push changes, including the `dist/` folder
22+
1. Make a GitHub release
23+
- set tag name to version
24+
- set release name to version
25+
- set release body to changelog entry for the version
26+
- attach the files in the `dist/` folder
27+
1. `npm publish .`

.github/ISSUE_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
(delete this line) GitHub Issues are NOT for support questions.
2+
(delete this line) GitHub Issues ARE for bug reports, feature requests, and other issues.
3+
(delete this line) Find out how to Get Support here: http://js-data.io/docs/support.
4+
5+
<your detailed, discussable, actionable, and helpful text goes here>
6+
7+
Thanks!

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
2+
3+
- [ ] - `npm test` succeeds
4+
- [ ] - Pull request has been squashed into 1 commit
5+
- [ ] - I did NOT commit changes to `dist/`
6+
- [ ] - Code coverage does not decrease (if any source code was changed)
7+
- [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
8+
- [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)

.npmignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
coverage
3+
doc
4+
rollup.config.js

scripts/AUTHORS renamed to AUTHORS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# This is the official list of js-data-adapter project authors.
22
#
3-
# This file is controlled by scripts/authors.js
4-
#
53
# Names are formatted as:
64
# # commits Name or Organization <email address>
75
# The email address is not required for organizations.
6+
Jason Dobry <[email protected]>

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
##### 0.1.0 - 06 March 2016
2+
3+
Initial release
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# People who have contributed to the js-data-adapter project.
22
#
3-
# This file is controlled by scripts/authors.js
4-
#
53
# Names should be added to this file as:
64
# [commit count] Name <email address>
5+
1 Jason Dobry <[email protected]>

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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+
3+
# js-data-adapter
4+
5+
[![Slack Status][sl_b]][sl_l]
6+
[![npm version][npm_b]][npm_l]
7+
[![npm downloads][dn_b]][dn_l]
8+
9+
Base adapter class that all other js-data adapters extend.
10+
11+
Refer to the various js-data adapter repositories to see how they extend
12+
`Adapter`.
13+
14+
## Table of contents
15+
16+
* [Quick start](#quick-start)
17+
* [Community](#community)
18+
* [Support](#support)
19+
* [Contributing](#contributing)
20+
* [License](#license)
21+
22+
## Quick Start
23+
24+
##### Browser-based adapter
25+
```
26+
npm i --save js-data
27+
npm i --save-dev js-data-adapter
28+
```
29+
30+
##### Node.js based adapter
31+
```
32+
npm i --save js-data js-data-adapter
33+
```
34+
35+
Now extend the adapter:
36+
37+
```js
38+
// ES6
39+
class MyAdapter extends Adapter {}
40+
```
41+
42+
```js
43+
// Use Adapter.extend
44+
var MyAdapter = Adapter.extend()
45+
```
46+
47+
```js
48+
// Manually extend
49+
function MyAdapter (opts) {
50+
Adapter.call(this, opts)
51+
}
52+
53+
// Setup prototype inheritance from Adapter
54+
MyAdapter.prototype = Object.create(Adapter.prototype, {
55+
constructor: {
56+
value: MyAdapter,
57+
enumerable: false,
58+
writable: true,
59+
configurable: true
60+
}
61+
})
62+
63+
Object.defineProperty(MyAdapter, '__super__', {
64+
configurable: true,
65+
value: Adapter
66+
})
67+
```
68+
69+
70+
## Community
71+
72+
[Explore the Community](http://js-data.io/docs/community).
73+
74+
## Support
75+
76+
[Find out how to Get Support](http://js-data.io/docs/support).
77+
78+
## Contributing
79+
80+
[Read the Contributing Guide](http://js-data.io/docs/contributing).
81+
82+
## License
83+
84+
The MIT License (MIT)
85+
86+
Copyright (c) 2016 js-data-adapter project authors
87+
88+
* [LICENSE](https://github.com/js-data/js-data-adapter/blob/master/LICENSE)
89+
* [AUTHORS](https://github.com/js-data/js-data-adapter/blob/master/AUTHORS)
90+
* [CONTRIBUTORS](https://github.com/js-data/js-data-adapter/blob/master/CONTRIBUTORS)
91+
92+
[sl_b]: http://slack.js-data.io/badge.svg
93+
[sl_l]: http://slack.js-data.io
94+
[npm_b]: https://img.shields.io/npm/v/js-data-adapter.svg?style=flat
95+
[npm_l]: https://www.npmjs.org/package/js-data-adapter
96+
[dn_b]: https://img.shields.io/npm/dm/js-data-adapter.svg?style=flat
97+
[dn_l]: https://www.npmjs.org/package/js-data-adapter

0 commit comments

Comments
 (0)