Skip to content

Commit

Permalink
add usage examples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
simbo committed Jan 2, 2021
1 parent 71a8d76 commit 0c739a7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ rm-node_modules
- [Install and Update](#install-and-update)
- [Installing manually](#installing-manually)
- [Usage](#usage)
- [Examples](#examples)
- [Configure](#configure)
- [FAQ](#faq)
- [Why not use a Oneliner?](#why-not-use-a-oneliner)
Expand Down Expand Up @@ -85,6 +86,27 @@ Options:
-v display version info only
```

### Examples

```sh
# run within configured default directory or current working directory
rmnm
# run within current working directory
rmnm -d .
# run with displaying disk usage
rmnm -u
# run with auto-confirming deletion
rmnm -y
# run with auto-confirming deletion and displaying disk usage
rmnm -uy
# run within ~/projects
rmnm -d ~/projects
# run within ~/projects and displaying disk usage
rmnm -u -d ~/projects
# run within ~/projects, display disk usage and auto-confirm deletion
rmnm -uy -d ~/projects
```

## Configure

You can optionally configure a default directory to search for node_modules:
Expand Down

0 comments on commit 0c739a7

Please sign in to comment.