Skip to content

Commit

Permalink
update readme about configuring default base directory
Browse files Browse the repository at this point in the history
  • Loading branch information
simbo committed Jan 1, 2021
1 parent 1d1b719 commit 67759d7
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If you experience any problems, please [create an issue](https://github.com/simb

## Install and Update

To install and/or update, simply run the following command:
To install and/or update the latest version, simply run the following command:

```sh
curl -so- https://raw.githubusercontent.com/simbo/rm-node_modules/master/install | bash
Expand All @@ -48,15 +48,32 @@ Make it executable: `chmod +x ./rm-node_modules`

And optionally link it with a short alias: `ln -s ./rm-node_modules rmnm`

## Configure

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

```sh
rmnm -c <DIR>

# for example:
rmnm -c ~/projects
```

If no default directory is configured, the current working directory will be used.

## Usage

```sh
Usage: rmnm [-yuv] [-d <DIR>]
Usage: rm-node_modules [-yuv] [-d <DIR> | -c <DIR>]

"Search for node_modules directories within given path and delete them."

Options:
-d <DIR> directory to search within (default: current directory)
-d <DIR> directory to search within
(default: current directory or configured default directory)
-y delete without confirmation
-u determine disk usage
-c <DIR> configure default directory to search within
-v display version info only
```

Expand Down

0 comments on commit 67759d7

Please sign in to comment.