diff --git a/packages/stylelint-plugin-mozaic/README b/packages/stylelint-plugin-mozaic/README new file mode 100644 index 000000000..1b2a187dd --- /dev/null +++ b/packages/stylelint-plugin-mozaic/README @@ -0,0 +1,21 @@ +

+ @mozaic-ds/stylelint-plugin-mozaic +

+================================== + +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` +