Skip to content

Commit 166e3b9

Browse files
committed
Update README with the current capabilities of the tool
1 parent 7a8d9a6 commit 166e3b9

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ systems including Rust, Node.js, Python, Java, and more.
99
## Usage
1010

1111
```
12-
> crufty help
1312
A command-line tool that scans projects for large build artifacts and cleans them up
1413
1514
Usage: crufty <COMMAND>
1615
1716
Commands:
18-
scan Scan for build artifacts in the current directory
19-
help Print this message or the help of the given subcommand(s)
17+
scan Scan for build artifacts in the current directory
18+
clean Clean all build artifacts in the current directory
19+
help Print this message or the help of the given subcommand(s)
2020
2121
Options:
2222
-h, --help Print help
2323
-V, --version Print version
2424
```
2525

26-
## Usage example
26+
## Usage examples
2727

2828
### Basic Scan
2929

@@ -39,3 +39,11 @@ Options:
3939
Total size: 1.4 GB in 4 directories
4040
Use `crufty clean` to remove these safely
4141
```
42+
43+
### Clean-up
44+
45+
```
46+
> crufty clean
47+
48+
4 directories were removed, restoring 1.4 GB
49+
```

0 commit comments

Comments
 (0)