add README.md

README.md

@@ -0,0 +1,86 @@
+# @vchikalkin/eslint-config-awesome
+
+- 🛠️ Most rules autofixable
+- 🎯 Designed to work with TypeScript, Nextjs, React projects
+- 🏆 Powered by [Canonical](https://github.com/gajus/eslint-config-canonical), [SonarJS](https://github.com/SonarSource/eslint-plugin-sonarjs)
+
+## 🚀 Usage
+
+### 📥 Install
+
+```bash
+yarn add -D eslint @vchikalkin/eslint-config-awesome
+```
+
+### ⚙️ Config `.eslintrc`
+
+For Next.js
+
+```json
+{
+  "extends": [
+    "@vchikalkin/eslint-config-awesome/next-typescript/config",
+    "@vchikalkin/eslint-config-awesome/next-typescript/rules"
+  ]
+}
+```
+
+For React
+
+```json
+{
+  "extends": [
+    "@vchikalkin/eslint-config-awesome/react-typescript/config",
+    "@vchikalkin/eslint-config-awesome/react-typescript/rules"
+  ]
+}
+```
+
+For TypeScript
+
+```json
+{
+  "extends": [
+    "@vchikalkin/eslint-config-awesome/typescript/config",
+    "@vchikalkin/eslint-config-awesome/typescript/rules"
+  ]
+}
+```
+
+### ➕ Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### ✨ Config VS Code auto fix
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), [VS Code Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and create `.vscode/settings.json`
+
+```json
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true,
+    "source.fixAll.eslint": true,
+    "source.removeUnusedImports": true
+  },
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "json",
+    "typescript",
+    "typescriptreact",
+    "yaml"
+  ],
+  "eslint.lintTask.enable": true
+}
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vchikalkin/eslint-config-awesome",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "license": "MIT",
   "main": "index.js",
   "dependencies": {