From 88fcacb4f81906d0716694e6d27e49d7b87fb1bf Mon Sep 17 00:00:00 2001 From: Col0ring <1561999073@qq.com> Date: Fri, 6 May 2022 23:49:52 +0800 Subject: [PATCH] docs: readme --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 22a209a..55dc1a3 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,25 @@ -# @col0ring/eslint-config -Col0ring's Eslint Config Presets. +# @col0ring/stylelint-config +Col0ring's Stylelint Config Presets. ## Install ```sh -npm install @col0ring/eslint-config -D +npm install @col0ring/stylelint-config -D # or -yarn add @col0ring/eslint-config -D +yarn add @col0ring/stylelint-config -D ``` ## Usage ```js -// .eslintrc.js +// stylelint.config.js module.exports = { - // js,ts and react - extends: ["@col0ring/eslint-config"] + extends: ["@col0ring/stylelint-config"] // or // extends: ["@col0ring"] } ``` if you need a separate configuration: ```js -// .eslintrc.js +// stylelint.config.js module.exports = { - // js ts and react - extends: ["@col0ring/eslint-config/basic","@col0ring/eslint-config/typescript","@col0ring/eslint-config/react"] + // css less + extends: ["@col0ring/stylelint-config/basic","@col0ring/stylelint-config/less"] } ```