Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit 6e43ace

Browse files
committed
Merge pull request #2 from mobify/readme-fix
Fixed some errors/omissions in the readme
2 parents b217cdb + 0ec6be9 commit 6e43ace

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Typically we lint our javascript files using [Grunt](http://gruntjs.com/). We ha
88

99
To add javascript linting to your project:
1010

11-
1. add `mobify-code-style` to your package.json, or `npm install` it
12-
2. Create a [Gruntfile](http://gruntjs.com/sample-gruntfile) if you don't have one already
13-
3. In the initConfig of your gruntfile, add sections for jshint and/or jscs pointing to the correct linting file
11+
1. Install the NPM `mobify-code-style`, `grunt-contrib-jshint`, and `grunt-contrib-jscs` modules.
12+
2. Create a [Gruntfile](http://gruntjs.com/sample-gruntfile) if you don't have one already.
13+
3. In the initConfig of your gruntfile, add sections for jshint and/or jscs pointing to the correct linting file.
1414

1515
Sample jshint config:
1616

@@ -19,6 +19,8 @@ jshint:{
1919
dev: {
2020
src: ['src/**/*.js'],
2121
options: {
22+
// The task fails if force is set to false. With true, it shows the
23+
// linting errors, but continues
2224
force: false,
2325
jshintrc: 'node_modules/mobify-code-style/javascript/.jshintrc'
2426
}

0 commit comments

Comments
 (0)