From c41edde1cdd8e35319b4430a55199fb31b9dba24 Mon Sep 17 00:00:00 2001 From: Gajus Kuizinas Date: Tue, 1 Nov 2016 15:57:08 +0000 Subject: [PATCH] docs: update documentation to reflect new option names (fixes #10) --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d8d275f..5aa041c 100644 --- a/README.md +++ b/README.md @@ -82,20 +82,18 @@ npm install create-index create-index --help Options: - --update-index Recursively iterates target directories looking for "index.js" - files that start with "'create index';\n" (create-index index - file). Updates found index files. Does not create new index - files. [boolean] [default: false] + --update, -u Recursively iterates target directories looking for "index.js" + files that start with "'create index';\n" (create-index index + file). Updates found index files. Does not create new index + files. [boolean] [default: false] Examples: - create-index ./src ./src/utilities Creates or updates an existing - create-index index file in the - target (./src, ./src/utilities) - directories. - create-index --update-index ./src Finds all create-index index files - ./tests in the target directories and - descending directories. Updates - found index files. + create-index ./src ./src/utilities Creates or updates an existing + create-index index file in the target + (./src, ./src/utilities) directories. + create-index --update ./src ./tests Finds all create-index index files in the + target directories and descending + directories. Updates found index files. ``` ### Using `create-index` Programmatically