mobin/create-index
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation to reflect new option names (fixes #10)

Browse Source
This commit is contained in:
Gajus Kuizinas
2016-11-01 15:57:08 +00:00
parent d05b635834
commit c41edde1cd
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -12
View File
@@ -82,20 +82,18 @@ npm install create-index
create-index --help create-index --help
Options: Options:
--update-index Recursively iterates target directories looking for "index.js" --update, -u Recursively iterates target directories looking for "index.js"
files that start with "'create index';\n" (create-index index files that start with "'create index';\n" (create-index index
file). Updates found index files. Does not create new index file). Updates found index files. Does not create new index
files. [boolean] [default: false] files. [boolean] [default: false]
Examples: Examples:
create-index ./src ./src/utilities Creates or updates an existing create-index ./src ./src/utilities Creates or updates an existing
create-index index file in the create-index index file in the target
target (./src, ./src/utilities) (./src, ./src/utilities) directories.
directories. create-index --update ./src ./tests Finds all create-index index files in the
create-index --update-index ./src Finds all create-index index files target directories and descending
./tests in the target directories and directories. Updates found index files.
descending directories. Updates
found index files.
``` ```
### Using `create-index` Programmatically ### Using `create-index` Programmatically