From bef439b18ee7b1e1ff5443a7c43d76505aacc366 Mon Sep 17 00:00:00 2001
From: Lev Chelyadinov <leva181777@gmail.com>
Date: Wed, 11 Sep 2024 13:17:03 +0200
Subject: [PATCH] Add `npx` to the running command (#100)

---
 README.md                  | 4 ++--
 packages/steiger/README.md | 8 +++++---
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 3089886..3a8eed0 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,13 @@ npm i -D steiger
 # Usage
 
 ```bash
-steiger ./src
+npx steiger ./src
 ```
 
 To run in watch mode, add `-w`/`--watch` to the command:
 
 ```bash
-steiger ./src --watch
+npx steiger ./src --watch
 ```
 
 # Configuration
diff --git a/packages/steiger/README.md b/packages/steiger/README.md
index 28e71af..3a8eed0 100644
--- a/packages/steiger/README.md
+++ b/packages/steiger/README.md
@@ -22,17 +22,19 @@ npm i -D steiger
 # Usage
 
 ```bash
-steiger ./src
+npx steiger ./src
 ```
 
 To run in watch mode, add `-w`/`--watch` to the command:
 
 ```bash
-steiger ./src --watch
+npx 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
@@ -40,7 +42,7 @@ import { defineConfig } from 'steiger'
 
 export default defineConfig({
   rules: {
-    'no-public-api': 'off',
+    'public-api': 'off',
   },
 })
 ```