diff --git a/README.md b/README.md index 7470057..61aca77 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # dir-size -A simple dotnet global tool to display the size of each sub-dir. +A simple dotnet global tool to calculate the size of each sub-dir. ## Install: @@ -9,6 +9,18 @@ dotnet tool install --global dir-size ## Usage: +```bash +Usage: dir-size [options] + +Options: + -v|--version Show version information + -?|-h|--help Show help information + -d|--dir The directory to work with, default is the current dir + -s|--sort Sort by size +``` + +### Example: + Current directory: ```bash dir-size @@ -19,5 +31,5 @@ dir-size -d path/to/dir ``` Sort by size: ```bash -dir-size -s +dir-size -s -d path/to/dir ```