Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bmacnaughton committed Oct 18, 2020
1 parent 1efca77 commit 604b299
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 604b299

Please sign in to comment.