Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
levchak0910 committed Dec 14, 2023
1 parent 737772d commit c45945b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# eslint-plugin-vue-kebab-class-naming
# eslint-plugin-vue-kebab-class-naming (VKCN)

[eslint-plugin-vue-kebab-class-naming](https://www.npmjs.com/package/eslint-plugin-vue-kebab-class-naming) is an ESLint plugin for ensuring a kebab-ish like class naming convention.

This convention was invited and relates only to this plugin. The convention was created to solve styles encapsulation via class naming. The description of the convention can be found in [rule documentation](./docs/rules/no-convention-violation.md).

Read more about CSS encapsulation and compare VKCN with other options in this [article](https://dev.to/levchak0910/new-old-way-to-write-css-1hml).

## Features

This ESLint plugin provides linting rules related to better class names usage.
Expand Down

0 comments on commit c45945b

Please sign in to comment.