Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Robinson <[email protected]>
  • Loading branch information
ssx committed Sep 18, 2019
1 parent 856fbd0 commit 32d778f
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# Skrub.

Skrub is a composer plugin that will remove useless files and free up some space,
especally useful when keeping Docker images small.
especially useful when trying to keep Docker images small. A lot of OSS project
owners use .gitattributes to strip junk out but the majority don't.


### Installation
Just run `composer install ssx/skrub` and you're good to go.


### Usage

Usage:
`composer skrub` will list the files Skrub feels it can safely remove and the
total disk space that can be regained.

Expand Down

0 comments on commit 32d778f

Please sign in to comment.