Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobLoach committed Feb 19, 2014
1 parent fc1bde6 commit 9b424ae
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 63 deletions.
17 changes: 16 additions & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@

<!-- LICENSEFILE -->
<!-- LICENSEFILE/ -->

# License

Copyright &copy; Rob Loach (http://github.com/RobLoach)

## The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<!-- /LICENSEFILE -->


13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,16 @@ Allows minification of HTML in [DocPad](https://docpad.org), using
Convention: `.html.anything`


<!-- INSTALL -->
<!-- INSTALL/ -->

## Install

### [Node](http://nodejs.org/)
- Use: `require('docpad-plugin-htmlmin')`
- Install: `npm install --save docpad-plugin-htmlmin`

<!-- /INSTALL -->


## Usage

Expand Down Expand Up @@ -117,7 +126,7 @@ No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:

- [Benjamin Lupton](https://github.com/balupton) <b@lupton.cc>[view contributions](https://github.com/RobLoach/docpad-plugin-htmlmin/commits?author=balupton)
- [RobLoach](https://github.com/RobLoach)[view contributions](https://github.com/RobLoach/docpad-plugin-htmlmin/commits?author=RobLoach)
- [Rob Loach](http://github.com/RobLoach)[view contributions](https://github.com/RobLoach/docpad-plugin-htmlmin/commits?author=RobLoach)

[Become a contributor!](https://github.com/RobLoach/docpad-plugin-htmlmin/blob/master/CONTRIBUTING.md#files)

Expand Down
120 changes: 60 additions & 60 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
{
"title": "HTML-Minifier Plugin for DocPad",
"name": "docpad-plugin-htmlmin",
"version": "2.3.2",
"description": "Adds support to minify HTML in DocPad.",
"license": {
"type": "MIT"
},
"homepage": "http://github.com/robloach/docpad-plugin-htmlmin",
"keywords": [
"docpad",
"docpad-plugin",
"html-minifier"
],
"badges": {
"travis": true,
"npm": true,
"gittip": "RobLoach",
"flattr": "2257574/RobLoach",
"david": true,
"daviddev": false
},
"author": "Rob Loach (http://github.com/RobLoach)",
"maintainers": [
"Rob Loach (http://github.com/RobLoach)"
],
"contributors": [
"Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
"RobLoach (https://github.com/RobLoach)"
],
"bugs": {
"url": "http://github.com/robloach/docpad-plugin-htmlmin/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/RobLoach/docpad-plugin-htmlmin.git"
},
"repo": "RobLoach/docpad-plugin-htmlmin",
"engines": {
"node": ">=0.4",
"docpad": "6.x"
},
"dependencies": {
"html-minifier": "~0.5.4"
},
"devDependencies": {
"coffee-script": "~1.7.1",
"docpad": ">=6.37 <7",
"projectz": "~0.3.10"
},
"main": "./out/lib/htmlmin.plugin.js",
"scripts": {
"test": "node ./out/test/htmlmin.test.js"
},
"directories": {
"lib": "./out/lib"
},
"peerDependencies": {
"docpad": "6"
}
}
"title": "HTML-Minifier Plugin for DocPad",
"name": "docpad-plugin-htmlmin",
"version": "2.4.0",
"description": "Adds support to minify HTML in DocPad.",
"license": {
"type": "MIT"
},
"homepage": "http://github.com/robloach/docpad-plugin-htmlmin",
"keywords": [
"docpad",
"docpad-plugin",
"html-minifier"
],
"badges": {
"travis": true,
"npm": true,
"gittip": "RobLoach",
"flattr": "2257574/RobLoach",
"david": true,
"daviddev": false
},
"author": "Rob Loach (http://github.com/RobLoach)",
"maintainers": [
"Rob Loach (http://github.com/RobLoach)"
],
"contributors": [
"Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
"Rob Loach (http://github.com/RobLoach)"
],
"bugs": {
"url": "http://github.com/robloach/docpad-plugin-htmlmin/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/RobLoach/docpad-plugin-htmlmin.git"
},
"repo": "RobLoach/docpad-plugin-htmlmin",
"engines": {
"node": ">=0.4",
"docpad": "6.x"
},
"dependencies": {
"html-minifier": "~0.5.4"
},
"devDependencies": {
"coffee-script": "~1.7.1",
"docpad": ">=6.37 <7",
"projectz": "~0.3.10"
},
"main": "./out/lib/htmlmin.plugin.js",
"scripts": {
"test": "node ./out/test/htmlmin.test.js"
},
"directories": {
"lib": "./out/lib"
},
"peerDependencies": {
"docpad": "6"
}
}

0 comments on commit 9b424ae

Please sign in to comment.