From 604b2995c001b5d172e1a1ffa6eb6c3f1d5b9cdd Mon Sep 17 00:00:00 2001 From: "Bruce A. MacNaughton" Date: Sun, 18 Oct 2020 12:18:15 -0700 Subject: [PATCH] update README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b82a17..5c13830 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # node-scrub -Remove files not necessary in a production node environment from a directory tree. +Walk a directory tree and remove files not necessary in a production node environment. WARNING: this program walks a directory tree and deletes files. Double check what you are doing before executing. The program's `--dry-run` option is `true` by default. @@ -44,7 +44,8 @@ elapsed time 18ms ## Command-line options -The first argument is the directory to delete. +The first argument is the root of the directory tree to walk, looking for +files and directories to delete. `--dry-run` - [true], use `--dry-run false` to delete files and directories. `--details, -d` - [false], show count and size for each match deleted.