Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(stylelint): add readme to mozaic-ds/stylelint-plugin-mozaic
- Loading branch information
1 parent
c4818ab
commit 103a437
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<h1 align="center"> | ||
@mozaic-ds/stylelint-plugin-mozaic | ||
</h1> | ||
================================== | ||
|
||
Overview | ||
-------- | ||
|
||
`@mozaic-ds/stylelint-plugin-mozaic` is a Stylelint plugin designed to enforce Mozaic's class naming conventions. This plugin ensures that your CSS aligns with the established standards of Mozaic, helping maintain consistency and readability across your project. | ||
|
||
Installation | ||
------------ | ||
|
||
To install the plugin, run the following command in your project directory: | ||
|
||
`npm install @mozaic-ds/stylelint-plugin-mozaic --save-dev` | ||
|
||
or | ||
|
||
`yarn add @mozaic-ds/stylelint-plugin-mozaic --dev` | ||
|