docs: update README files

Author: axelrindle

README.md

@@ -1,35 +1,12 @@
-# @actcoding/eslint-config
+# eslint-config
 
-> An opinionated eslint flat config.
+> A set of opinionated eslint configs and plugins we use in most of our projects.
 
-This package provides multiple, opinionated eslint configs we use in our projects.
+## Projects
 
-## Install
-
-```shell
-npm install -D @actcoding/eslint-config
-```
-
-## Usage
-
-`eslint.config.js`
-
-```js
-import { configActDefault } from '@actcoding/eslint-config'
-
-/** @type {import('eslint').Linter.Config[]} */
-const config = [
-    ...configActDefault,
-    {
-        ignores: [
-            '*.d.ts',
-        ]
-    }
-]
-
-export default config
-```
+- [`eslint-config`](./packages/eslint-config/README.md): The main shareable ESLint config
+- [`eslint-plugin-import-newlines`](./packages/eslint-plugin-import-newlines/README.md): A customized, typed and updated version of [SeinopSys/eslint-plugin-import-newlines](https://github.com/SeinopSys/eslint-plugin-import-newlines)
 
 ## License
 
-[MIT](LICENSE)
+All packages are published under the [MIT license](LICENSE)

packages/eslint-config/README.md

@@ -0,0 +1,31 @@
+# @actcoding/eslint-config
+
+> An opinionated eslint flat config.
+
+This package provides multiple, opinionated eslint configs we use in our projects.
+
+## Install
+
+```shell
+npm install -D @actcoding/eslint-config
+```
+
+## Usage
+
+`eslint.config.js`
+
+```js
+import { configActDefault } from '@actcoding/eslint-config'
+
+/** @type {import('eslint').Linter.Config[]} */
+const config = [
+    ...configActDefault,
+    {
+        ignores: [
+            '*.d.ts',
+        ]
+    }
+]
+
+export default config
+```

packages/eslint-plugin-import-newlines/README.md

@@ -0,0 +1,70 @@
+# @actcoding/eslint-plugin-import-newlines
+
+> ESLint plugin for enforcing newlines in ES6 import statements past a certain number of items.
+
+Parts of the code are taken from [SeinopSys/eslint-plugin-import-newlines](https://github.com/SeinopSys/eslint-plugin-import-newlines), which is also [MIT licensed](https://github.com/SeinopSys/eslint-plugin-import-newlines/blob/main/LICENSE.md).
+
+## Install
+
+```shell
+npm install -D @actcoding/eslint-plugin-import-newlines
+```
+
+## Usage
+
+### Provided config (recommended)
+
+`eslint.config.js`
+
+```js
+import importNewlinesPlugin from '@actcoding/eslint-plugin-import-newlines'
+
+/** @type {import('eslint').Linter.Config[]} */
+const config = [
+    importNewlinesPlugin.configs.recommended,
+]
+
+export default config
+```
+
+### Manual
+
+`eslint.config.js`
+
+```js
+import importNewlinesPlugin from '@actcoding/eslint-plugin-import-newlines'
+
+/** @type {import('eslint').Linter.Config[]} */
+const config = [
+    {
+        name: 'app/style/imports',
+        plugins: {
+            '@import-newlines': importNewlinesPlugin,
+        },
+        rules: {
+            '@import-newlines/enforce': [
+                'error',
+                {
+                    'maxItems': 4,
+                    'maxLineLength': 120,
+                },
+            ],
+        },
+    },
+]
+
+export default config
+```
+
+## Rules
+
+### `@import-newlines/enforce`
+
+Enforce multiple lines for import statements past a certain number of items
+
+#### Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| maxItems | `integer` | 4 | maximum amount of imported items per line |
+| maxLineLength | `integer` | 120 | maximum line length of an import statement |

packages/eslint-plugin-import-newlines/lib/rules/enforce/index.ts

@@ -28,7 +28,7 @@ const plugin: Rule.RuleModule = {
     meta: {
         type: 'layout',
         docs: {
-            description: 'enforce multiple lines for import statements past a certain number of items',
+            description: 'Enforce multiple lines for import statements past a certain number of items',
             category: 'Stylistic Issues',
             url: 'https://github.com/actcoding/eslint-config',
         },