Skip to content

Commit

Permalink
Docs: Update README.md
Browse files Browse the repository at this point in the history
Add note about line-ending issues on Windows machines and add AppVeyor build status batch.

Speaking of line-endings; add a trailing one to `.gitattributes`.
  • Loading branch information
macedigital committed Jun 26, 2017
1 parent 7ec45d8 commit 6620fa4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# Force LF end of line for styles and scripts
*.css text eol=lf
*.js text eol=lf
*.js text eol=lf
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![NPM Version][npm-image]][npm-url]
[![Dependency Status][deps-image]][deps-url]
[![Build Status][ci-image]][ci-url]
[![Build Status][appveyor-image]][appveyor-url]
[![Code Coverage status][codecov-image]][codecov-url]

Adds [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) hashes to HTML files.
Expand Down Expand Up @@ -43,6 +44,10 @@ Referenced css- and js-files must be accessible from the local filesystem. In or

A `crossorigin=anonymous` attribute will be added to all updated DOM nodes, unless the attribute has been already been set to value `use-credentials`. In the latter case the `crossorigin` attribute is left unchanged.

**For Windows Users:**

Make sure that all non-binary files (e.g. css- and js-files) are saved with `LF` file endings. Not doing so will cause a [file checksum mismatch](https://github.com/macedigital/gulp-sri-hash/issues/6) when running tests or fetching deployed assets from a web server.

## API

### algo (optional)
Expand Down Expand Up @@ -106,3 +111,6 @@ MIT License
[ci-url]: https://travis-ci.org/macedigital/gulp-sri-hash
[codecov-image]:https://img.shields.io/codecov/c/github/macedigital/gulp-sri-hash.svg?style=flat
[codecov-url]:https://codecov.io/github/macedigital/gulp-sri-hash
[appveyor-image]:https://ci.appveyor.com/api/projects/status/in9jtvifuxc0ct9w?svg=true
[appveyor-url]:https://ci.appveyor.com/project/macedigital/gulp-sri-hash

0 comments on commit 6620fa4

Please sign in to comment.