Update usage

textlint · Jul 29, 2020 · 3ceb09b · 3ceb09b
1 parent 6b7349a
commit 3ceb09b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/@textlint/compiler/README.md b/packages/@textlint/compiler/README.md
@@ -10,7 +10,16 @@ Install with [npm](https://www.npmjs.com/):
 
 ## Usage
 
-- [ ] Write usage instructions
+    Usage
+      $ textlint-compiler 
+
+    Options
+      --cwd              current working directory
+      --textlintrc       [path:String] path to .textlintrc file. Default: load .textlintrc.{json,yaml,js}
+      --output-dir       [path:String] output file path that is written of reported result.
+
+    Examples
+      $ textlint-compiler --output-dir ./dist
 
 ## Demo
 

diff --git a/packages/@textlint/compiler/src/cli.ts b/packages/@textlint/compiler/src/cli.ts
@@ -9,8 +9,8 @@ export const cli = meow(
  
     Options
       --cwd              current working directory
-      --textlintrc       [path:String] path to .textlintrc file
-      --output-dir           [path:String] output file path that is written of reported result.
+      --textlintrc       [path:String] path to .textlintrc file. Default: load .textlintrc.{json,yaml,js}
+      --output-dir       [path:String] output file path that is written of reported result.
  
     Examples
       $ textlint-compiler --output-dir ./dist