@octohash/eslint-config 0.1.3 → 0.2.0

package/README.md

@@ -4,83 +4,45 @@
 [![JSDocs][jsdocs-src]][jsdocs-href]
 [![License][license-src]][license-href]
 
-A comprehensive ESLint configuration package optimized for **application development**, built on top of [@antfu/eslint-config](https://github.com/antfu/eslint-config). This configuration provides a robust foundation for modern web applications with built-in support for Vue, TypeScript, and **Tailwind CSS v4**.
+A personal ESLint config, built as an extension of
+[`@antfu/eslint-config`](https://github.com/antfu/eslint-config).
 
-Since the target is web application development, CSS and HTML formatting are enabled by default.
-
-## Installation
+## Install
 
 ```bash
-pnpm add -D @octohash/eslint-config
+pnpm add -D @octohash/eslint-config eslint
 ```
 
 ## Usage
 
-### Basic Setup
-
-Create an `eslint.config.js` file in your project root:
-
-```javascript
+```ts
 import { defineConfig } from '@octohash/eslint-config'
 
 export default defineConfig()
 ```
 
-### With Custom Options
-
-```javascript
-import { defineConfig } from '@octohash/eslint-config'
-
-export default defineConfig(
-  {
-    vue: true,
-    formatters: {
-      css: true,
-      html: true,
-    },
-  },
-  {
-    files: ['**/*.test.ts'],
-    rules: {
-      'no-unused-vars': 'off',
-    },
-  }
-)
-```
-
-### Tailwind CSS v4 Setup
-
-1. Install Tailwind CSS v4:
-```bash
-pnpm add tailwindcss@4
-```
-
-2. Create your CSS file with v4 syntax:
-```css
-@import 'tailwindcss';
+## What This Adds
 
-/* Your custom styles */
-```
+- Adds first-class `Tailwind CSS` linting/formatting rules powered by
+  [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss)
+- Includes `catalogs-sort` rules for consistent dependency catalog ordering
 
-3. The ESLint configuration will automatically detect and validate your Tailwind CSS usage.
+## Tailwind CSS
 
-## Migration from @antfu/eslint-config
+No extra setup is required in most projects:
 
-If you're currently using `@antfu/eslint-config` directly, you can easily migrate:
+- Tailwind v4: auto-detects a CSS entry that imports `tailwindcss`
+- Tailwind v3: auto-detects `tailwind.config.*`
 
-**Before:**
-```javascript
-import antfu from '@antfu/eslint-config'
+You can still override with `settings.entryPoint` or `settings.tailwindConfig`
+when needed.
 
-export default antfu()
-```
+## Credits
 
-**After:**
-```javascript
-import { defineConfig } from '@octohash/eslint-config'
-
-export default defineConfig()
-```
+Inspired by
+[`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
+and
+[`eslint-config-hyoban`](https://github.com/hyoban/eslint-config-hyoban).
 
 ## License