diff --git a/packages/eslint/CHANGELOG.md b/packages/eslint/CHANGELOG.md index 79f3d7ad..87ed08c7 100644 --- a/packages/eslint/CHANGELOG.md +++ b/packages/eslint/CHANGELOG.md @@ -1,8 +1,13 @@ # @nft-team/eslint-config +## 1.0.1 + +### Patch Changes + +- docs: @nft-team/eslint-config 문서 README.md 생성 + ## 1.0.0 ### Major Changes - @nft-team/eslint-config 초기 publish - diff --git a/packages/eslint/README.md b/packages/eslint/README.md new file mode 100644 index 00000000..8c558eeb --- /dev/null +++ b/packages/eslint/README.md @@ -0,0 +1,45 @@ +# 🚧 WIP 🚧 @nft-team/eslint-config + + + + + + + + + +## 🚀 Quick Overview + +Install `@nft-team/eslint-config` dependency + +```bash +npm install --save-dev @nft-team/eslint-config +``` + +Add `@nft-team/eslint-config` to `extends` in your `.eslintrc` + +```js +module.exports = { + // ... + extends: ['@nft-team/eslint-config'], + rules: { + // ... + }, +}; +``` + +## 🤔 What eslint extensions does `@nft-team/eslint-config` have? +- [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) +- [eslint-config-airbnb-typescript](https://www.npmjs.com/package/eslint-config-airbnb-typescript) +- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) +- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks) +- [eslint-plugin-simple-import-sort](https://www.npmjs.com/package/eslint-plugin-simple-import-sort) +- [eslint-plugin-unused-imports](https://www.npmjs.com/package/eslint-plugin-unused-imports) + +[View more extensions..](https://github.com/mbti-nf-team/frontend-libraries/blob/main/packages/eslint/index.js) + +## 🐛 Bug reporting +[Issues](https://github.com/mbti-nf-team/frontend-libraries/issues) + +## 🔒 LICENSE +This Project is [MIT licensed](https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE). diff --git a/packages/eslint/package.json b/packages/eslint/package.json index 27905c17..f199fd26 100644 --- a/packages/eslint/package.json +++ b/packages/eslint/package.json @@ -1,6 +1,6 @@ { "name": "@nft-team/eslint-config", - "version": "1.0.0", + "version": "1.0.1", "description": "nft team eslint config", "main": "index.js", "license": "MIT", @@ -9,6 +9,15 @@ "name": "SEUNGMIN SA (Harang)", "url": "https://github.com/saseungmin" }, + "keywords": [ + "nft-team", + "eslint-config-airbnb", + "eslint-config-airbnb-typescript", + "eslint-import", + "eslint-plugin-react", + "eslint-plugin-simple-import-sort", + "eslint-plugin-unused-imports" + ], "repository": { "type": "git", "url": "https://github.com/mbti-nf-team/frontend-libraries.git"