Skip to content

Commit

Permalink
📝 updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aka-somix committed Jul 25, 2024
1 parent df9f61e commit 39d0577
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Delgarbo - DELete GARBage On your laptop
# Delgarbo - DELetes GARBage On your laptop
This script will gently delete all the garbage folders (caches mainly) that are filling up your machine and you no longer need.

## Usage
Expand All @@ -13,7 +13,7 @@ sh delgarbo <Base Path>
Where `<Base Path>` could be any path (that your user has access to).
Example:
```
sh delgarbo ~/my/git/projects/path
delgarbo ~/my/git/projects/path
```

### Base Path Suggestions
Expand All @@ -27,4 +27,12 @@ Just copy the script to a directory already in the path.
sudo cp delgarbo /usr/local/bin
```

You are now ready to use it directly from wherever in your shell.
You are now ready to use it directly from wherever in your shell.

## Cache folder Supported

- [x] Node Modules
- [x] Terragrunt cache
- [x] CDK out
- [ ] Python cache
- [ ] *please suggest others*
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.0
2.0.0

0 comments on commit 39d0577

Please sign in to comment.