@enormora/eslint-config-base 0.0.11 → 0.0.12

package/package.json

@@ -1,4 +1,8 @@
 {
+    "author": "Mathias Schreck <schreck.mathias@gmail.com>",
+    "contributors": [
+        "Christian Rackerseder <github@echooff.de>"
+    ],
     "dependencies": {
         "@cspell/eslint-plugin": "8.3.2",
         "@stylistic/eslint-plugin": "1.5.4",
@@ -12,6 +16,7 @@
         "eslint-plugin-sonarjs": "0.23.0",
         "eslint-plugin-unicorn": "50.0.1"
     },
+    "description": "Enormora’s ESLint base configuration",
     "license": "MIT",
     "main": "base.js",
     "name": "@enormora/eslint-config-base",
@@ -20,5 +25,5 @@
         "url": "git://github.com/enormora/eslint-config.git"
     },
     "type": "module",
-    "version": "0.0.11"
+    "version": "0.0.12"
 }

package/readme.md

@@ -0,0 +1,24 @@
+# `@enormora/eslint-config-base`
+
+Base ESLint config preset, agnostic to any environment, framework, or library. Targets ESM-only projects.
+
+## Install & Setup
+
+Install the `@enormora/eslint-config-base` package via npm:
+
+```bash
+npm install --save-dev @enormora/eslint-config-base
+```
+
+Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and add the base config to the configuration array:
+
+```javascript
+import { baseConfig } from '@enormora/eslint-config-base';
+
+export default [
+    {
+        ignores: ['dist/**/*']
+    },
+    baseConfig
+];
+```