Skip to content

Commit 3b09031

Browse files
committed
docs: update readme
1 parent 0270f9a commit 3b09031

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# eslint-plugin-check-file
22

3+
[![NPM Version][npm-image]][npm-url]
4+
[![NPM Downloads][downloads-image]][downloads-url]
5+
36
ESLint rules for consistent filename and folder. Allows you to enforce a consistent naming pattern for the filename and folder.
47

58
## Installation
@@ -75,3 +78,9 @@ Then configure the rules you want to use under the rules section.
7578
- [check-file/no-index](docs/rules/no-index.md): A file cannot be named "index"
7679
- [check-file/folder-naming-convention](docs/rules/folder-naming-convention.md): Enforce a consistent naming pattern for the name of the specified folder
7780
- [check-file/filename-blacklist](docs/rules/filename-blacklist.md): Blacklist file names by pattern
81+
82+
83+
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-check-file.svg
84+
[npm-url]: https://www.npmjs.com/package/eslint-plugin-check-file
85+
[downloads-image]: https://img.shields.io/npm/dm/eslint-plugin-check-file.svg
86+
[downloads-url]: https://www.npmjs.com/package/eslint-plugin-check-file

0 commit comments

Comments
 (0)