# Quick Start

## Installation

Install the package:

```bash
# Using pnpm (recommended)
pnpm add @bitfactory/eslint-config --save-dev --save-exact

# Using npm
npm install @bitfactory/eslint-config --save-dev --save-exact
```

For detailed installation instructions including peer dependencies and Vue/TypeScript setup, see [Installation](docs/01-installation.md) documentation.

## Configuration

Create an `eslint.config.js` file in your project root:

```js
import bitfactoryBase from '@bitfactory/eslint-config';
import gitignore from 'eslint-config-flat-gitignore';

export default [
    // Automatically ignore .gitignore patterns
    gitignore(),
    // Base Javascript config
    ...bitfactoryBase,
];
```

For more configuration examples including Vue and TypeScript setups, see [Configuration](docs/02-configuration.md) documentation.

## CLI Usage

Add scripts to your `package.json`:

```json
{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "pnpm run lint --fix"
  }
}
```

Run with:

```bash
pnpm run lint
pnpm run lint:fix
```

For more extensive CLI usage examples, see [CLI Usage](docs/03-cli-usage.md) documentation.