Merge pull request #33 from heldinz/update-markdown

Update markdown

Author: heldinz

LICENSE.md

@@ -0,0 +1,23 @@
+<!-- markdownlint-disable MD041 -->
+
+MIT License
+
+Copyright (c) 2014 Alice Rose
+
+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.

README.md

@@ -1,8 +1,6 @@
 # [gulp](http://gulpjs.com)-convert-encoding
 
-![Build Status](https://github.com/heldinz/gulp-convert-encoding/actions/workflows/main.yml/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/heldinz/gulp-convert-encoding/badge.svg?branch=main)](https://coveralls.io/r/heldinz/gulp-convert-encoding?branch=main)
-[![NPM Downloads](https://img.shields.io/npm/dm/gulp-convert-encoding.svg)](https://www.npmjs.com/package/gulp-convert-encoding)
+[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] ![Build Status][ci-image] [![Coveralls Status][coveralls-image]][coveralls-url]
 
 > Convert file encodings using [iconv-lite](https://github.com/ashtuchkin/iconv-lite).
 
@@ -57,6 +55,13 @@ Default: `{ decode: {}, encode: {} }`
 
 Allows you to pass additional options into `iconv-lite`, for example [BOM Handling](https://github.com/ashtuchkin/iconv-lite#bom-handling).
 
-## License
+<!-- prettier-ignore-start -->
+[npm-url]: https://www.npmjs.com/package/gulp-convert-encoding
+[npm-image]: https://img.shields.io/npm/v/gulp-convert-encoding.svg?style=flat-square
+[downloads-image]: https://img.shields.io/npm/dm/gulp-convert-encoding.svg?style=flat-square
 
-MIT © [Alice Rose](https://github.com/heldinz)
+[ci-image]: https://img.shields.io/github/actions/workflow/status/heldinz/gulp-convert-encoding/main.yml?branch=main&style=flat-square
+
+[coveralls-url]: https://coveralls.io/r/heldinz/gulp-convert-encoding?branch=main
+[coveralls-image]: https://img.shields.io/coverallsCoverage/github/heldinz/gulp-convert-encoding?branch=main&style=flat-square
+<!-- prettier-ignore-end -->

package.json

@@ -16,15 +16,16 @@
 		"coverage:html": "nyc --reporter=html npm test",
 		"coverage:lcov": "nyc --reporter=lcovonly npm test",
 		"format": "npm run prettier -- --write",
-		"lint": "echo 'TODO: linting'",
+		"lint": "echo 'TODO: lint JS'",
 		"prettier": "prettier .*rc *.{js,json,md}",
 		"test": "mocha -R spec",
 		"test:watch": "npm test -- --watch",
 		"validate": "npm run lint && npm run prettier -- --list-different",
 		"prepare": "husky"
 	},
 	"lint-staged": {
-		"'.*rc', '*.{js,json,md}'": "prettier --write",
+		"*.{js,json,md}": "npm run format",
+		".*rc": "npm run format",
 		"*.js": "npm run lint"
 	},
 	"files": ["index.js"],