Skip to content

Commit

Permalink
Closes #10.
Browse files Browse the repository at this point in the history
Stable Version 1.0.0-alpha.1-1.
  • Loading branch information
jmdobry committed Oct 20, 2014
1 parent 64215ce commit 19ebccb
Show file tree
Hide file tree
Showing 18 changed files with 1,160 additions and 695 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,8 @@
##### 1.0.0-alpha.1-1 - 19 October 2014

###### Backwards compatible API changes
- #10 - Add js-data-schema integration

##### 1.0.0-alpha.1-0 - 13 October 2014

###### Backwards compatible API changes
Expand Down
4 changes: 3 additions & 1 deletion Gruntfile.js
Expand Up @@ -61,7 +61,8 @@ module.exports = function (grunt) {
options: {
browserifyOptions: {
standalone: 'JSData'
}
},
external: ['js-data-schema']
},
dist: {
files: {
Expand All @@ -85,6 +86,7 @@ module.exports = function (grunt) {
options: {
files: [
'dist/js-data.min.js',
'bower_components/js-data-schema/dist/js-data-schema.min.js',
'bower_components/js-data-http/dist/js-data-http.min.js',
'bower_components/js-data-localstorage/dist/js-data-localstorage.min.js',
'karma.start.js',
Expand Down
33 changes: 24 additions & 9 deletions README.md
Expand Up @@ -4,15 +4,15 @@

Inspired by [Ember Data](https://github.com/emberjs/data), js-data is the model layer you've been craving. It consists of a convenient framework-agnostic, in-memory cache for managing your data, which users adapters to communicate with various persistence layers.

You can use the [http adapter](http://www.js-data.io/js-data-http), which is perfect for communicating with your RESTful backend. You could also use the [localStorage adapter](http://www.js-data.io/js-data-localstorage). More adapters are coming, and you're free to implement your own.
You can use the [http adapter](http://www.js-data.io/docs/dshttpadapter), which is perfect for communicating with your RESTful backend. You could also use the [localStorage adapter](http://www.js-data.io/docs/dslocalstorageadapter). More adapters are coming, and you're free to implement your own. View available adapters [here](http://www.js-data.io/docs/adapters).

Unlike Backbone and Ember Models, js-data does not require the use of getters and setters, and doesn't wrap your data with custom classes if you don't want it to. js-data's internal dirty-checking (via [observe-js](https://github.com/Polymer/observe-js) or `Object.observe` in supporting browsers) allows for powerful use cases and an easy avenue for implementing your own [3-way data-binding](https://www.firebase.com/blog/2013-10-04-firebase-angular-data-binding.html).

Supporting relations, computed properties, model lifecycle control and a slew of other features, js-data is the tool for giving your data the respect it deserves.

__Latest Release:__ [1.0.0-alpha.1-0](https://github.com/js-data/js-data/releases/tag/1.0.0-alpha.1-0)
__Latest Release:__ [1.0.0-alpha.1-1](https://github.com/js-data/js-data/releases/tag/1.0.0-alpha.1-1)

js-data is pre-alpha. The API is subject to change, though the current api is well tested.
js-data is pre-release. The API is subject to change, though the current api is well tested.

If you want to use js-data, keep a close eye on the changelog. 1.0.0 will introduce strict semver (until then, minor number is bumped for breaking changes).

Expand Down Expand Up @@ -43,12 +43,27 @@ User.find(1).then(function (user) {

All your data are belong to you...

## API
- [DS](DS)
- [DSHttpAdapter](DSHttpAdapter)
- [DSLocalStorageAdapter](DSLocalStorageAdapter)
- [DSFirebaseAdapter](DSFirebaseAdapter)
- [Schemator](Schemator)
## Guides
- [Getting Started with js-data](http://www.js-data.io/docs/home)
- [Resources](http://www.js-data.io/docs/resources)
- [Working with the Data Store](http://www.js-data.io/docs/working-with-the-data-store)
- [Adapters](http://www.js-data.io/docs/working-with-adapters)
- [Model Lifecycle](http://www.js-data.io/docs/model-lifecycle)
- [Custom Instance Behavior](http://www.js-data.io/docs/custom-instance-behavior)
- [Computed Properties](http://www.js-data.io/docs/computed-properties)
- [Relations](http://www.js-data.io/docs/relations)
- [Schemata & Validation](http://www.js-data.io/docs/schemata--validation)
- [FAQ](http://www.js-data.io/docs/faq)

## API Documentation
- [DS](http://www.js-data.io/docs/ds)
- [Schemator](http://www.js-data.io/docs/js-data-schema)
- [DSHttpAdapter](http://www.js-data.io/docs/dshttpadapter)
- [DSLocalStorageAdapter](http://www.js-data.io/docs/dslocalstorageadapter)
- [DSLocalForageAdapter](http://www.js-data.io/docs/dslocalforageadapter)
- [DSFirebaseAdapter](http://www.js-data.io/docs/dsfirebaseadapter)
- [DSRedisAdapter](http://www.js-data.io/docs/dsredisadapter)
- [DSRethinkDBAdapter](http://www.js-data.io/docs/dsrethinkdbadapter)

## Changelog
[CHANGELOG.md](https://github.com/js-data/js-data/blob/master/CHANGELOG.md)
Expand Down
3 changes: 2 additions & 1 deletion bower.json
@@ -1,7 +1,7 @@
{
"name": "js-data",
"description": "Robust, framework-agnostic in-memory data store.",
"version": "1.0.0-alpha.1-0",
"version": "1.0.0-alpha.1-1",
"homepage": "http://www.js-data.io",
"repository": {
"type": "git",
Expand Down Expand Up @@ -31,6 +31,7 @@
],
"devDependencies": {
"observe-js": "0.3.4",
"js-data-schema": "~0.1.x",
"js-data-http": "~0.4.x",
"js-data-localstorage": "~0.4.x"
}
Expand Down

0 comments on commit 19ebccb

Please sign in to comment.