Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jonschlinkert committed Sep 8, 2018
1 parent 8d8068e commit e5aeb27
Showing 1 changed file with 52 additions and 37 deletions.
89 changes: 52 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# gulp-htmlmin [![NPM version](https://img.shields.io/npm/v/gulp-htmlmin.svg?style=flat)](https://www.npmjs.com/package/gulp-htmlmin) [![NPM monthly downloads](https://img.shields.io/npm/dm/gulp-htmlmin.svg?style=flat)](https://npmjs.org/package/gulp-htmlmin) [![NPM total downloads](https://img.shields.io/npm/dt/gulp-htmlmin.svg?style=flat)](https://npmjs.org/package/gulp-htmlmin) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/gulp-htmlmin.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/gulp-htmlmin)
# gulp-htmlmin [![NPM version](https://img.shields.io/npm/v/gulp-htmlmin.svg?style=flat)](https://www.npmjs.com/package/gulp-htmlmin) [![NPM monthly downloads](https://img.shields.io/npm/dm/gulp-htmlmin.svg?style=flat)](https://npmjs.org/package/gulp-htmlmin) [![NPM total downloads](https://img.shields.io/npm/dt/gulp-htmlmin.svg?style=flat)](https://npmjs.org/package/gulp-htmlmin) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/gulp-htmlmin.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/gulp-htmlmin)

> gulp plugin to minify HTML.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.

## Install

Install with [npm](https://www.npmjs.com/):
Expand All @@ -10,47 +12,47 @@ Install with [npm](https://www.npmjs.com/):
$ npm install --save gulp-htmlmin
```

_Issues with the HTML parser and output must be reported on the [html-minifier](https://github.com/kangax/html-minifier/issues) issue tracker._
## Heads up!

_**Please do not report issues related to HTML parsing and output on this repository. Report those issues to the [html-minifier](https://github.com/kangax/html-minifier/issues) issue tracker.**_

## Usage

See the [html-minifer docs](https://github.com/kangax/html-minifier) for all available options.

```js
var gulp = require('gulp');
var htmlmin = require('gulp-htmlmin');
const gulp = require('gulp');
const htmlmin = require('gulp-htmlmin');

gulp.task('minify', function() {
gulp.task('minify', () => {
return gulp.src('src/*.html')
.pipe(htmlmin({collapseWhitespace: true}))
.pipe(htmlmin({ collapseWhitespace: true }))
.pipe(gulp.dest('dist'));
});
```

See the [html-minifer docs](https://github.com/kangax/html-minifier) for options.

## About

### Contributing
<details>
<summary><strong>Contributing</strong></summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Contributors
</details>

<details>
<summary><strong>Running Tests</strong></summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

| **Commits** | **Contributor** |
| --- | --- |
| 41 | [shinnn](https://github.com/shinnn) |
| 20 | [jonschlinkert](https://github.com/jonschlinkert) |
| 8 | [doowb](https://github.com/doowb) |
| 7 | [stevelacy](https://github.com/stevelacy) |
| 2 | [TheDancingCode](https://github.com/TheDancingCode) |
| 1 | [cwonrails](https://github.com/cwonrails) |
| 1 | [igoradamenko](https://github.com/igoradamenko) |
| 1 | [oblador](https://github.com/oblador) |
| 1 | [jdalton](https://github.com/jdalton) |
| 1 | [JoseChirivella14](https://github.com/JoseChirivella14) |
| 1 | [nschloe](https://github.com/nschloe) |
| 1 | [tomByrer](https://github.com/tomByrer) |

### Building docs
</details>

<details>
<summary><strong>Building docs</strong></summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

Expand All @@ -60,31 +62,44 @@ To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests
</details>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
### Contributors

```sh
$ npm install && npm test
```
| **Commits** | **Contributor** |
| --- | --- |
| 41 | [shinnn](https://github.com/shinnn) |
| 20 | [jonschlinkert](https://github.com/jonschlinkert) |
| 11 | [doowb](https://github.com/doowb) |
| 7 | [stevelacy](https://github.com/stevelacy) |
| 2 | [TheDancingCode](https://github.com/TheDancingCode) |
| 1 | [cwonrails](https://github.com/cwonrails) |
| 1 | [igoradamenko](https://github.com/igoradamenko) |
| 1 | [oblador](https://github.com/oblador) |
| 1 | [jdalton](https://github.com/jdalton) |
| 1 | [JoseChirivella14](https://github.com/JoseChirivella14) |
| 1 | [nschloe](https://github.com/nschloe) |
| 1 | [tomByrer](https://github.com/tomByrer) |

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)

**Shinnosuke Watanabe**

* [github/shinnn](https://github.com/shinnn)
* [twitter/shinnn_tw](https://twitter.com/shinnn_tw)
* [GitHub Profile](https://github.com/shinnn)
* [Twitter Profile](https://twitter.com/shinnn_tw)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)

### License

Copyright © 2014-2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Copyright © 2018, [Shinnosuke Watanabe](https://github.com/shinnn).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on December 24, 2017._
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 08, 2018._

0 comments on commit e5aeb27

Please sign in to comment.