Skip to content

Commit 80ef5a9

Browse files
author
John F. Mercer
committed
Fixes README
1 parent 118e2cf commit 80ef5a9

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,18 @@
44
[![devDependency Status](https://david-dm.org/radify/angular-scaffold/dev-status.svg)](https://david-dm.org/radify/angular-scaffold#info=devDependencies)
55
[![Code Climate](https://codeclimate.com/github/radify/angular-scaffold/badges/gpa.svg)](https://codeclimate.com/github/radify/angular-scaffold)
66

7-
Angular Scaffold
8-
==
7+
# Angular Scaffold
98

10-
Description
11-
--
9+
## Simple scaffolding for AngularJS
1210

13-
Angular Scaffold is a collection of convenience wrappers around angular-model collections.
11+
**Angular Scaffold** is a collection of convenience wrappers around angular-model collections.
1412

15-
Dependencies
16-
--
13+
## Dependencies
1714

1815
* [AngularJS](https://angularjs.org/)
1916
* [Angular Model](https://www.npmjs.com/package/angular-model)
2017

21-
Running unit tests
22-
--
18+
## Running unit tests
2319

2420
Install the test runner with npm:
2521

@@ -39,13 +35,11 @@ You can run coverage with:
3935
gulp coverage
4036
```
4137

42-
angular-scaffold API docs
43-
--
38+
## angular-scaffold API docs
4439

4540
See [/docs/api.md](/docs/api.md) in this project for detailed documentation of all angular-scaffold's functions.
4641

47-
Supporting angular-scaffold in your API
48-
--
42+
## Supporting angular-scaffold in your API
4943

5044
Your API must:
5145

@@ -68,8 +62,7 @@ Your API must:
6862
]
6963
```
7064

71-
Basic Usage
72-
--
65+
## Basic Usage
7366

7467
In your AngularJS application, include the JavaScript:
7568

@@ -98,8 +91,7 @@ Example controller using Angular Scaffold:
9891
})
9992
```
10093

101-
Basic CRUD example project
102-
--
94+
## Basic CRUD example project
10395

10496
An [example application is included in this repository](/sample-project/). It has a very simple API that illustrates a basic use case for angular-scaffold.
10597

@@ -113,8 +105,7 @@ node server.js
113105

114106
You can then browse to http://localhost:4730/ and add/remove Post objects from a list. angular-scaffold takes care of talking to the API for you.
115107

116-
Pagination
117-
--
108+
## Pagination
118109

119110
angular-scaffold can paginate your model. Your API will need to support the `Range: resources=n-n` header to take advantage of this. For example, `Range: resources=10-20` would return resources 10 through 20.
120111

@@ -124,8 +115,7 @@ paginate: { size: 20, page: 1, strategy: 'paged' }
124115
});
125116
```
126117

127-
Querying
128-
--
118+
## Querying
129119

130120
You can pass a specific query in, which will be sent through to the API. Your API will have to know how to respond to this.
131121

0 commit comments

Comments
 (0)