From a9371283353e4d3959cb34d4f709f1c31379c263 Mon Sep 17 00:00:00 2001 From: John Vandenberg Date: Tue, 26 Mar 2024 15:25:54 +0800 Subject: [PATCH] chore: Mention npx in README (#467) --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1b48b2e..3927312 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # cspell-cli +## Usage + +To check all files under the current directory, run: + +``` +npx cspell-cli --gitignore . +``` + ## Setup [pre-commit](https://pre-commit.com) Hook This repository enables using [cspell](https://github.com/streetsidesoftware/cspell) as a [pre-commit](https://pre-commit.com) hook.