Skip to content

Commit

Permalink
Stable Version 2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Nov 12, 2015
1 parent 37d42b3 commit 034c97b
Show file tree
Hide file tree
Showing 19 changed files with 1,061 additions and 708 deletions.
34 changes: 0 additions & 34 deletions .jshintrc

This file was deleted.

36 changes: 36 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Logs
logs
*.log

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# Commenting this out is preferred by some people, see
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
node_modules

# Users Environment Variables
.lock-wscript

.idea/
*.iml
coverage/
src/
test/
mocha.start.js
webpack.config.js
9 changes: 3 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
sudo: false
language: node_js
node_js:
- "stable"
- "0.12"
- "0.10"
services:
- redis-server
before_install:
- npm install -g npm
- npm install -g grunt-cli
script:
- grunt test
- grunt coveralls || true
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
##### 2.3.0 - 11 November 2015

###### Other
- Rebuilt with Babel 6
- Dropped Grunt
- Integrated js-data-adapter-tests

##### 2.2.0 - 09 September 2015

###### Backwards compatible API changes
Expand Down
43 changes: 33 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,47 @@
# Contributing Guide

First, support is handled via the [Gitter Channel](https://gitter.im/js-data/js-data) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
First, support is handled via the [Slack Channel](http://slack.js-data.io) and
the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions
there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
When submitting issues on GitHub, please include as much detail as possible to
make debugging quick and easy.

- good - Your versions of js-data, js-data-redis, etc., relevant console logs/error, code examples that revealed the issue
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
- good - Your versions of js-data, js-data-redis, etc., relevant console
logs/error, code examples that revealed the issue
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
[bin](http://jsbin.com/?html,output) that demonstrates the issue
- best - A Pull Request that fixes the issue, including test coverage for the
issue and the fix

[Github Issues](https://github.com/js-data/js-data-redis/issues).

#### Submitting Pull Requests

1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
1. Contribute to the issue/discussion that is the reason you'll be developing in
the first place
1. Fork js-data-redis
1. `git clone [email protected]:<you>/js-data-redis.git`
1. `cd js-data-redis; npm install; bower install;`
1. `cd js-data-redis; npm install;`
1. Write your code, including relevant documentation and tests
1. Run `grunt test` (build and test)
1. Run `npm test` (build and test)
- You need io.js or Node 4.x that includes generator support without a flag
1. Your code will be linted and checked for formatting, the tests will be run
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
will be committed when a release is cut.
1. Submit your PR and we'll review!
1. Thanks!
1. Thanks!

#### Have write access?

Here's how to make a release on the `master` branch:

1. Bump `package.json` to the appropriate version.
1. `npm test` must succeed.
1. This time, the built `dist/js-data-redis.js` file _will_ be committed, so stage its changes.
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
1. Push to master.
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
1. `npm publish .` (Make sure you got the version bumped correctly!)
96 changes: 0 additions & 96 deletions Gruntfile.js

This file was deleted.

74 changes: 50 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,14 @@
<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" />

## js-data-redis [![npm version](https://img.shields.io/npm/v/js-data-redis.svg?style=flat-square)](https://www.npmjs.org/package/js-data-redis) [![Travis CI](https://img.shields.io/travis/js-data/js-data-redis.svg?style=flat-square)](https://travis-ci.org/js-data/js-data-redis) [![npm downloads](https://img.shields.io/npm/dm/js-data-redis.svg?style=flat-square)](https://www.npmjs.org/package/js-data-redis) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/js-data/js-data-redis/blob/master/LICENSE)
## js-data-redis [![Slack Status][sl_b]][sl_l] [![npm version][npm_b]][npm_l] [![Travis CI][travis_b]][travis_l] [![npm downloads][dn_b]][dn_l] [![Coverage Status][cov_b]][cov_l] [![Codacy][cod_b]][cod_l]

Redis adapter for [js-data](http://www.js-data.io/).

### API Documentation
[DSRedisAdapter](http://www.js-data.io/docs/dsredisadapter)

### Project Status

__Latest Release:__ [![Latest Release](https://img.shields.io/github/release/js-data/js-data-redis.svg?style=flat-square)](https://github.com/js-data/js-data-redis/releases)

__Status:__

[![Codacity](https://img.shields.io/codacy/64cca2890a594370a5c9f4d5c0e3fcc3.svg?style=flat-square)](https://www.codacy.com/public/jasondobry/js-data-redis/dashboard)

__Supported Platforms:__

[![node version](https://img.shields.io/badge/Node-0.10%2B-green.svg?style=flat-square)](https://github.com/js-data/js-data)

### Quick Start
`npm install --save js-data js-data-redis`.
`npm install --save js-data js-data-redis redis`.

```js
var JSData = require('js-data');
Expand All @@ -38,11 +26,13 @@ store.registerAdapter('redis', adapter, { default: true });
// "store" will now use the Redis adapter for all async operations
```

Read about using [JSData on the Server](http://www.js-data.io/docs/jsdata-on-the-server).

### Changelog
[CHANGELOG.md](https://github.com/js-data/js-data-redis/blob/master/CHANGELOG.md)

### Community
- [Gitter Channel](https://gitter.im/js-data/js-data) - Better than IRC!
- [Slack Channel](http://slack.js-data.io) - Better than IRC!
- [Announcements](http://www.js-data.io/blog)
- [Mailing List](https://groups.io/org/groupsio/jsdata) - Ask your questions!
- [Issues](https://github.com/js-data/js-data-redis/issues) - Found a bug? Feature request? Submit an issue!
Expand All @@ -51,29 +41,52 @@ store.registerAdapter('redis', adapter, { default: true });

### Contributing

First, support is handled via the [Gitter Channel](https://gitter.im/js-data/js-data) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
First, support is handled via the [Slack Channel](http://slack.js-data.io) and
the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions
there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
When submitting issues on GitHub, please include as much detail as possible to
make debugging quick and easy.

- good - Your versions of js-data, js-data-redis, etc., relevant console logs/error, code examples that revealed the issue
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
- good - Your versions of js-data, js-data-redis, etc., relevant console
logs/error, code examples that revealed the issue
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
[bin](http://jsbin.com/?html,output) that demonstrates the issue
- best - A Pull Request that fixes the issue, including test coverage for the
issue and the fix

[Github Issues](https://github.com/js-data/js-data-redis/issues).

#### Submitting Pull Requests

1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
1. Contribute to the issue/discussion that is the reason you'll be developing in
the first place
1. Fork js-data-redis
1. `git clone [email protected]:<you>/js-data-redis.git`
1. `cd js-data-redis; npm install; bower install;`
1. `cd js-data-redis; npm install;`
1. Write your code, including relevant documentation and tests
1. Run `grunt test` (build and test)
1. Run `npm test` (build and test)
- You need io.js or Node 4.x that includes generator support without a flag
1. Your code will be linted and checked for formatting, the tests will be run
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
will be committed when a release is cut.
1. Submit your PR and we'll review!
1. Thanks!

#### Have write access?

Here's how to make a release on the `master` branch:

1. Bump `package.json` to the appropriate version.
1. `npm test` must succeed.
1. This time, the built `dist/js-data-redis.js` file _will_ be committed, so stage its changes.
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
1. Push to master.
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
1. `npm publish .` (Make sure you got the version bumped correctly!)

### License

The MIT License (MIT)
Expand All @@ -97,3 +110,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[sl_b]: http://slack.js-data.io/badge.svg
[sl_l]: http://slack.js-data.io
[npm_b]: https://img.shields.io/npm/v/js-data-redis.svg?style=flat
[npm_l]: https://www.npmjs.org/package/js-data-redis
[travis_b]: https://img.shields.io/travis/js-data/js-data-redis.svg
[travis_l]: https://travis-ci.org/js-data/js-data-redis
[dn_b]: https://img.shields.io/npm/dm/js-data-redis.svg?style=flat
[dn_l]: https://www.npmjs.org/package/js-data-redis
[cov_b]: https://img.shields.io/coveralls/js-data/js-data-redis/master.svg?style=flat
[cov_l]: https://coveralls.io/github/js-data/js-data-redis?branch=master
[cod_b]: https://img.shields.io/codacy/64cca2890a594370a5c9f4d5c0e3fcc3.svg
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-redis/dashboard
Loading

0 comments on commit 034c97b

Please sign in to comment.