Skip to content

Commit

Permalink
Couple of documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Mar 29, 2014
1 parent 1385dde commit 4ae36b5
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
###### Backwards compatible API changes
- #37 - Add option to only save changed attributes when calling DS.save()

##### 0.8.0 - 13 March 2014

###### Backwards compatible API changes
- #37 - Add option to only save changed attributes when calling DS.save()

###### Backwards compatible bug fixes
- #38 - "saved" attribute item isn't being updated properly

Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,38 @@

__Data store for Angular.js.__

__Current version:__ 0.7.1
__Current version:__ 0.8.0

Angular-data is in a pre-1.0.0 development stage; the API is fluctuating, not a lot of tests yet, etc.

Not for production use (yet).
Not for production use (yet). If you still want to develop with Angular-data, be prepared to keep a close eye on the changelog, as the API is very liable to change (a lot).

Pending:
- Roadmap
- A Solid Roadmap
- Relations/Associations
- Various Adapters
- Schema Definition/Validation
- Cache Expiry
- Nested Resources
- Website / documentation
- 100% tested (whatever _that_ means)
- See [issues](https://github.com/jmdobry/angular-data/issues?milestone=7&page=1&state=open) for what's in development
- See [Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) for other juicy reading material

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

## Resources

#### Community
[Mailing List](https://groups.google.com/forum/?fromgroups#!forum/angular-data) - Ask your questions!

[Issues](https://github.com/jmdobry/angular-data/issues) - Found a bug? Feature request? Submit an issue!

[GitHub](https://github.com/jmdobry/angular-data) - View the source code for angular-data.

[Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) - Design document for Angular-data.

## Project Status

| Branch | Master |
Expand Down
3 changes: 1 addition & 2 deletions guide/angular-data/overview.doc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Angular-data is an in-browser data store for [Angular.js](http://angularjs.org).
[Synchronous methods](/documentation/guide/synchronous/index) work only with data already in the data store, and
[asynchronous methods](/documentation/guide/asynchronous/index) work with persistence layer.
[asynchronous methods](/documentation/guide/asynchronous/index) work with a persistence layer.

<p>
<img src="/resources/img/chart.png" width="940">
Expand All @@ -16,7 +16,6 @@ Angular-data is an in-browser data store for [Angular.js](http://angularjs.org).
angular.module('myApp', ['angular-data.DS'])
.config(function (DSProvider) {
DSProvider.defaults.baseUrl = 'https://example.com/api';
{...}
})
.run(function (DS) {
DS.defineResource({
Expand Down

0 comments on commit 4ae36b5

Please sign in to comment.