Skip to content

Commit d1a5149

Browse files
committed
Added license property to package meta information and to README for clarity
1 parent 5a4c8b3 commit d1a5149

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

README.markdown

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ HTML\_CodeSniffer can be called in multiple ways:
2020
* Called directly in JavaScript source, HTML_CodeSniffer will provide a list of known
2121
and potential violations to the calling script.
2222
* It also comes with a pop-up auditor interface, accessible via a bookmarklet,
23-
letting you browse through messages emitted from one of the defined standards.
23+
letting you browse through messages emitted from one of the defined standards.
2424
Where possible, the auditor also points you to the HTML element causing the problem.
2525
* It can also be run on the command line with the assistance of a headless browser app.
2626
* Using npm:
@@ -41,18 +41,18 @@ please see the file "licence.txt".
4141
The HTML\_CodeSniffer auditor can be built using [node.js](https://nodejs.org/) and the Grunt
4242
tasker (http://gruntjs.com/). It has been tested with the latest version of node.js
4343
(at time of writing: version 6.0) and Grunt, but should also work with recent
44-
earlier versions.
44+
earlier versions.
4545

4646
* Install node.js with your package manager of choice.
47-
* You may need to update the Node.js package manager (npm) itself:
47+
* You may need to update the Node.js package manager (npm) itself:
4848
<code>npm update -g npm</code>
4949
* Install the Grunt CLI helper if you haven't already done so:
5050
<code>npm install -g grunt-cli</code>
5151
* Get node.js to install the dependencies Grunt needs:
5252
<code>npm install</code>
5353
* Run Grunt to build the auditor:
5454
<code>grunt build</code>
55-
55+
5656
You should see two new directories: <code>node_modules</code> (containing the node.js
5757
dependencies), and <code>build</code> (containing your auditor). You can then move
5858
(or symlink as appropriate) your <code>build</code> directory to a web-accessible
@@ -66,7 +66,7 @@ replace the directory at the start (//squizlabs.github.io/HTML_CodeSniffer/build
6666
If you are developing using HTML\_CodeSniffer and require the code not minified for
6767
debugging purposes, follow the above steps, but run <code>grunt build-debug</code>
6868
(instead of just build). This will combine the files as normal, but not minify them.
69-
69+
7070
### Command-Line processing
7171

7272
**Note:** These examples assume a built version of HTMLCS exported to `./build/HTMLCS.js`
@@ -75,7 +75,7 @@ debugging purposes, follow the above steps, but run <code>grunt build-debug</cod
7575

7676
You will need [PhantomJS](http://www.phantomjs.org/) installed if you wish to
7777
use the contributed command-line script. PhantomJS provides a headless Webkit-based
78-
browser to run the scripts in, so it should provide results that are similar to
78+
browser to run the scripts in, so it should provide results that are similar to
7979
recent (or slightly less than recent) versions of Safari.
8080

8181
See the <code>Contrib/PhantomJS/HTMLCS_Run.js</code> file for more information.
@@ -150,4 +150,8 @@ More information on HTML_CodeSniffer can be found on its GitHub site,
150150
Special thanks to:
151151

152152
* [nsulzycki](https://github.com/nsulzycki) (Polish Translation)
153-
* [dmassiani](https://github.com/dmassiani) (French Translation)
153+
* [dmassiani](https://github.com/dmassiani) (French Translation)
154+
155+
## License
156+
157+
Licensed under [the BSD 3-Clause "New" or "Revised" License](https://opensource.org/licenses/BSD-3-Clause).

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "html_codesniffer",
33
"version": "2.2.0",
44
"description": "HTML_CodeSniffer is a client-side JavaScript that checks a HTML document or source code, and detects violations of a defined coding standard.",
5+
"license": "BSD-3-Clause",
56
"main": "index.js",
67
"keywords": [
78
"htmlcs"
@@ -28,4 +29,4 @@
2829
"devDependencies": {
2930
"grunt-contrib-uglify": "^2.3.0"
3031
}
31-
}
32+
}

0 commit comments

Comments
 (0)