diff --git a/README.md b/README.md index 85cd7bf..213eeb4 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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: