From 3ceb09b57c15dc9173116cac336dcb567a2d27b1 Mon Sep 17 00:00:00 2001 From: azu Date: Wed, 29 Jul 2020 16:57:51 +0900 Subject: [PATCH] Update usage --- packages/@textlint/compiler/README.md | 11 ++++++++++- packages/@textlint/compiler/src/cli.ts | 4 ++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/packages/@textlint/compiler/README.md b/packages/@textlint/compiler/README.md index 38406de..79bcead 100644 --- 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 index bdafa83..ee6b461 100644 --- 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