Skip to content

Commit f6d040a

Browse files
committed
Documentation content and style updates.
1 parent fb65a0e commit f6d040a

36 files changed

+444
-260
lines changed

Gruntfile.js

+13-26
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,14 @@ module.exports = function (grunt) {
4444
jshintrc: '.jshintrc'
4545
},
4646
watch: {
47-
files: ['src/**/*.js'],
48-
tasks: ['build']
47+
dist: {
48+
files: ['src/**/*.js'],
49+
tasks: ['build']
50+
},
51+
doc: {
52+
files: ['src/**/*.js', 'guide/**/*'],
53+
tasks: ['devdoc']
54+
}
4955
},
5056
uglify: {
5157
main: {
@@ -198,37 +204,16 @@ module.exports = function (grunt) {
198204
{
199205
expand: true,
200206
cwd: 'guide/',
201-
src: 'index.html',
207+
src: ['index.html', 'favicon.ico'],
202208
dest: 'doc/',
203209
flatten: true
204210
},
205211
{
206212
expand: true,
207213
cwd: 'guide/',
208-
src: 'data_grey.png',
214+
src: ['data_grey.png'],
209215
dest: 'doc/resources/img/',
210216
flatten: true
211-
},
212-
{
213-
expand: true,
214-
cwd: 'guide/',
215-
src: 'chart.png',
216-
dest: 'doc/resources/img/',
217-
flatten: true
218-
},
219-
{
220-
expand: true,
221-
cwd: 'guide/',
222-
src: 'cream_dust.png',
223-
dest: 'doc/resources/img/',
224-
flatten: true
225-
},
226-
{
227-
expand: true,
228-
cwd: 'guide/',
229-
src: 'favicon.ico',
230-
dest: 'doc/',
231-
flatten: true
232217
}
233218
]
234219
}
@@ -382,13 +367,15 @@ module.exports = function (grunt) {
382367

383368
grunt.registerTask('test', ['build', 'karma:ci', 'karma:cacheFactory', 'karma:DSCacheFactory', 'karma:min']);
384369
grunt.registerTask('doc', ['clean:doc', 'docular', 'concat', 'copy', 'uglify:scripts']);
370+
grunt.registerTask('devdoc', ['clean:doc', 'docular', 'concat', 'copy']);
385371
grunt.registerTask('build', [
386372
'clean',
387373
'jshint',
388374
'browserify',
389375
'banner',
390376
'uglify:main'
391377
]);
392-
grunt.registerTask('go', ['build', 'watch']);
378+
grunt.registerTask('go', ['build', 'watch:dist']);
379+
grunt.registerTask('godoc', ['devdoc', 'watch:doc']);
393380
grunt.registerTask('default', ['build']);
394381
};

README.md

+34-25
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## angular-data
22

3-
Inspired by [Ember Data](https://github.com/emberjs/data), Angular-data is the model layer Angular is missing. It consists of a convenient in-memory cache for interacting with your various resources, and several adapters for communicating with various persistence layers.
3+
Inspired by [Ember Data](https://github.com/emberjs/data), Angular-data is the model layer Angular is missing. It consists of a convenient in-memory cache for managing your data, and several adapters for communicating with various persistence layers.
44

55
By default angular-data uses the http adapter–perfect for communicating with your RESTful backend. It includes a localStorage adapter, and another [localforage adapter](https://github.com/jmdobry/angular-data-localForage) is also available. More adapters are coming, and you're free to implement your own.
66

@@ -19,8 +19,19 @@ Although angular-data is being used in production, it's not 1.0.0. If you want t
1919
## Documentation
2020
[http://angular-data.pseudobry.com](http://angular-data.pseudobry.com)
2121

22+
## Project Status
23+
24+
| Branch | Master |
25+
| ------ | ------ |
26+
| Bower | [![Bower version](https://badge.fury.io/bo/angular-data.png)](http://badge.fury.io/bo/angular-data) |
27+
| NPM | [![NPM version](https://badge.fury.io/js/angular-data.png)](http://badge.fury.io/js/angular-data) |
28+
| Build Status | [![Build Status](https://travis-ci.org/jmdobry/angular-data.png?branch=master)](https://travis-ci.org/jmdobry/angular-data) |
29+
| Code Climate | [![Code Climate](https://codeclimate.com/github/jmdobry/angular-data.png)](https://codeclimate.com/github/jmdobry/angular-data) |
30+
| Dependency Status | [![Dependency Status](https://gemnasium.com/jmdobry/angular-data.png)](https://gemnasium.com/jmdobry/angular-data) |
31+
| Coverage | [![Coverage Status](https://coveralls.io/repos/jmdobry/angular-data/badge.png?branch=master)](https://coveralls.io/r/jmdobry/angular-data?branch=master) |
32+
2233
## Quick Start
23-
`bower install angular-data` or `npm install angular-data`.
34+
`bower install --save angular-data` or `npm install --save angular-data`.
2435

2536
```js
2637
var app = angular.module('myApp', ['angular-data.DS']);
@@ -67,35 +78,33 @@ app.controller('friendsCtrl', function ($scope, $routeParams, User) {
6778
});
6879
```
6980

81+
## Guide
82+
- [Overview](/documentation/guide/angular-data/index)
83+
- [Basics](/documentation/guide/angular-data/overview)
84+
- [Defining Resources](/documentation/guide/angular-data-resource/basic)
85+
- [Asynchronous Methods](/documentation/guide/angular-data/asynchronous)
86+
- [Synchronous Methods](/documentation/guide/angular-data/synchronous)
87+
- [Queries & Filtering](/documentation/guide/angular-data/queries)
88+
- [Adapters](/documentation/guide/angular-data/adapters)
89+
- [How do I...?](/documentation/guide/angular-data/how)
90+
91+
## API
92+
- [Overview](/documentation/api/angular-data/angular-data)
93+
- [DS](/documentation/api/angular-data/DS)
94+
- [DSHttpAdapter](/documentation/api/angular-data/DSHttpAdapter)
95+
7096
## Changelog
7197
[CHANGELOG.md](https://github.com/jmdobry/angular-data/blob/master/CHANGELOG.md)
7298

7399
## Version Migration
74100
[TRANSITION.md](https://github.com/jmdobry/angular-data/blob/master/TRANSITION.md)
75101

76-
## Resources
77-
78-
#### Community
79-
[Mailing List](https://groups.google.com/forum/?fromgroups#!forum/angular-data) - Ask your questions!
80-
81-
[Issues](https://github.com/jmdobry/angular-data/issues) - Found a bug? Feature request? Submit an issue!
82-
83-
[GitHub](https://github.com/jmdobry/angular-data) - View the source code for angular-data.
84-
85-
[Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) - Design document for Angular-data.
86-
87-
[Contributing Guide](#Contributing)
88-
89-
## Project Status
90-
91-
| Branch | Master |
92-
| ------ | ------ |
93-
| Bower | [![Bower version](https://badge.fury.io/bo/angular-data.png)](http://badge.fury.io/bo/angular-data) |
94-
| NPM | [![NPM version](https://badge.fury.io/js/angular-data.png)](http://badge.fury.io/js/angular-data) |
95-
| Build Status | [![Build Status](https://travis-ci.org/jmdobry/angular-data.png?branch=master)](https://travis-ci.org/jmdobry/angular-data) |
96-
| Code Climate | [![Code Climate](https://codeclimate.com/github/jmdobry/angular-data.png)](https://codeclimate.com/github/jmdobry/angular-data) |
97-
| Dependency Status | [![Dependency Status](https://gemnasium.com/jmdobry/angular-data.png)](https://gemnasium.com/jmdobry/angular-data) |
98-
| Coverage | [![Coverage Status](https://coveralls.io/repos/jmdobry/angular-data/badge.png?branch=master)](https://coveralls.io/r/jmdobry/angular-data?branch=master) |
102+
## Community
103+
- [Mailing List](https://groups.google.com/forum/?fromgroups#!forum/angular-data) - Ask your questions!
104+
- [Issues](https://github.com/jmdobry/angular-data/issues) - Found a bug? Feature request? Submit an issue!
105+
- [GitHub](https://github.com/jmdobry/angular-data) - View the source code for angular-data.
106+
- [Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) - Design document for Angular-data.
107+
- [Contributing Guide](#Contributing)
99108

100109
## Contributing
101110

0 commit comments

Comments
 (0)