docs: for --read-files

harttle · May 5, 2024 · 11de27e · 11de27e
1 parent 02a82e0
commit 11de27e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,12 +41,15 @@ Options:
   --version       Show version number        [boolean]
   --in-place, -i  edit file in place         [boolean]
   --ignore-words, -I  ignore padding within/before/after these words  [string]
+  --read-files, -r    read a file list containing one file per line, use empty value to read from STDIN  [string]
 
 Examples:
   stdout    md-padding README.md
   in-place  md-padding -i README.md
   pipe      cat README.md | md-padding
   ignore-words  cat README.md | md-padding -I '=' '::'
+  batch format  cat list.txt | md-padding -r -i
+  equivalent w/ md-padding -r list.txt -i
 ```
 
 ### 在 Vim 中使用

diff --git a/src/bin/md-padding.ts b/src/bin/md-padding.ts
@@ -27,7 +27,7 @@ yargs
   .option('read-files', {
     alias: 'r',
     type: 'string',
-    description: 'STDIN as file list'
+    description: 'read a file list containing one file per line, use empty value to read from STDIN'
   })
   .alias('help', 'h')
   .example('stdout', 'mdp README.md')