From f8f419c6e1e03f24de5658f14b62dd0dee85ca24 Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Mon, 31 Jul 2023 16:58:34 +0800 Subject: [PATCH] Update README for autocorrect-node --- autocorrect-node/README.md | 12 ++++++++++++ autocorrect-node/npm/darwin-arm64/README.md | 4 ++-- autocorrect-node/npm/darwin-x64/README.md | 4 ++-- autocorrect-node/npm/linux-x64-gnu/README.md | 4 ++-- autocorrect-node/npm/win32-x64-msvc/README.md | 4 ++-- 5 files changed, 20 insertions(+), 8 deletions(-) diff --git a/autocorrect-node/README.md b/autocorrect-node/README.md index 6ba48b15..49fedcb5 100644 --- a/autocorrect-node/README.md +++ b/autocorrect-node/README.md @@ -16,6 +16,18 @@ The Native Node.js version of [AutoCorrect](https://github.com/huacnlee/autocorr $ yarn add autocorrect-node ``` +## Use CLI + +```bash +$ yarn autocorrect -h +``` + +Lint you files + +```bash +$ yarn autocorrect --lint . +``` + ## Usage ```js diff --git a/autocorrect-node/npm/darwin-arm64/README.md b/autocorrect-node/npm/darwin-arm64/README.md index dcd60f6b..4d60e678 100644 --- a/autocorrect-node/npm/darwin-arm64/README.md +++ b/autocorrect-node/npm/darwin-arm64/README.md @@ -1,3 +1,3 @@ -# `@huacnlee/autocorrect-node-darwin-arm64` +# `autocorrect-node-darwin-arm64` -This is the **aarch64-apple-darwin** binary for `@huacnlee/autocorrect-node` +This is the **aarch64-apple-darwin** binary for [autocorrect-node](https://www.npmjs.com/package/autocorrect-node) diff --git a/autocorrect-node/npm/darwin-x64/README.md b/autocorrect-node/npm/darwin-x64/README.md index 288cdc0d..7dd47bf3 100644 --- a/autocorrect-node/npm/darwin-x64/README.md +++ b/autocorrect-node/npm/darwin-x64/README.md @@ -1,3 +1,3 @@ -# `@huacnlee/autocorrect-node-darwin-x64` +# `autocorrect-node-darwin-x64` -This is the **x86_64-apple-darwin** binary for `@huacnlee/autocorrect-node` +This is the **x86_64-apple-darwin** binary for [autocorrect-node](https://www.npmjs.com/package/autocorrect-node) diff --git a/autocorrect-node/npm/linux-x64-gnu/README.md b/autocorrect-node/npm/linux-x64-gnu/README.md index 26bb6b4f..fc20211b 100644 --- a/autocorrect-node/npm/linux-x64-gnu/README.md +++ b/autocorrect-node/npm/linux-x64-gnu/README.md @@ -1,3 +1,3 @@ -# `@huacnlee/autocorrect-node-linux-x64-gnu` +# `autocorrect-node-linux-x64-gnu` -This is the **x86_64-unknown-linux-gnu** binary for `@huacnlee/autocorrect-node` +This is the **x86_64-unknown-linux-gnu** binary for [autocorrect-node](https://www.npmjs.com/package/autocorrect-node) diff --git a/autocorrect-node/npm/win32-x64-msvc/README.md b/autocorrect-node/npm/win32-x64-msvc/README.md index 5810338f..1f72572e 100644 --- a/autocorrect-node/npm/win32-x64-msvc/README.md +++ b/autocorrect-node/npm/win32-x64-msvc/README.md @@ -1,3 +1,3 @@ -# `@huacnlee/autocorrect-node-win32-x64-msvc` +# `autocorrect-node-win32-x64-msvc` -This is the **x86_64-pc-windows-msvc** binary for `@huacnlee/autocorrect-node` +This is the **x86_64-pc-windows-msvc** binary for [autocorrect-node](https://www.npmjs.com/package/autocorrect-node)