Skip to content

Commit

Permalink
Mention that Steiger is zero-config
Browse files Browse the repository at this point in the history
  • Loading branch information
illright authored Aug 10, 2024
1 parent 55c182a commit 829859e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ steiger ./src --watch

# Configuration

Steiger is zero-config! If you don't want to disable certain rules, you can safely skip this section.

Steiger is configurable via `cosmiconfig`. That means that you can create a `steiger.config.ts` or `steiger.config.js` file in the root of your project to configure the rules. Import `{ defineConfig } from "steiger"` to get autocompletion.

```ts
Expand Down

0 comments on commit 829859e

Please sign in to comment.