Skip to content

Commit f1c4de1

Browse files
committed
updated REAME
1 parent fd97390 commit f1c4de1

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ A seed project for building out a new api. Supports resource-based routing, Seq
77
* [Dependencies](#dependencies)
88
* [Signals](#signals)
99
* [Migrations](#migrations)
10+
* [Docs](#docs)
1011

1112

1213
## Getting Started
13-
- nvm install 0.10.22
14-
- npm install -g mocha
14+
- nvm install 0.10.26
15+
- npm install -g mocha grunt-cli
1516
- npm install
1617
- edit /conf/development.js && /conf/test.js database information appropriately
1718
- createdb api_dev ; createdb api_test
1819
- nvm use
1920
- npm test
2021
- npm start
22+
- optionally, run 'grunt watch' for [JSHint][jshint] results on saves
2123

2224
### Dependencies
2325
- [Node.js ≥ 0.10.22][node]
@@ -46,9 +48,13 @@ Api Starter uses [Sequelize's][sequelize] built in migration support. [Docs her
4648

4749
**IMPORTANT** do *NOT* use the global sequelize binary ie) `sequelize -m`. Use the binary installed locally to the node_modules folder.
4850

51+
### Docs
52+
The default grunt task generates documentation using [APIDoc][apidoc].
4953

5054
[node]: http://nodejs.org/ "Node.js"
5155
[cluster]: http://nodejs.org/docs/v0.10.22/api/cluster.html "Cluster - Node v0.10.22"
5256
[redis]: http://redis.io/download "Redis"
5357
[postgres]: http://www.postgresql.org/ "Postgres"
54-
[sequelize]: http://http://sequelizejs.com/ "Sequelize"
58+
[sequelize]: http://http://sequelizejs.com/ "Sequelize"
59+
[jshint]: http://www.jshint.com/docs/ "JSHint"
60+
[apidoc]: http://apidocjs.com/ "APIDocJS"

0 commit comments

Comments
 (0)