Update README for autocorrect-node

huacnlee · Jul 31, 2023 · f8f419c · f8f419c
1 parent 33025cf
commit f8f419c
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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)