Update README.md, go.mod

README.md

@@ -1,3 +1,41 @@
 # xcclear
 
-Simple and easy to use command line application written in Go for cleaning unnecessary XCode files.
+Say hello to a few extra gigabytes of space on your Mac with xcclear, a simple and easy to use command line application written in Go for cleaning unnecessary XCode files.
+
+## Installation
+
+    brew install xcclear
+
+## Screenshots
+Run ```xcclear -d``` to diagnose your storage:  
+
+![diagnose](https://user-images.githubusercontent.com/44027725/113197954-9d19d480-9265-11eb-90ee-e360553e1e0f.gif)
+
+
+Run ```xcclear -p``` to purge all unwanted files from your storage:  
+
+![purge](https://user-images.githubusercontent.com/44027725/113198953-d30b8880-9266-11eb-9c6e-f7cfc9b91a82.gif)
+
+
+## Options
+
+flag                       |   type    | description
+-------------------------- | --------- | ------------------------------------------
+`-d/--diagnose`            | `bool`    | Diagnose the total space occupied by derived data, caches and other XCode related files.<br>
+`-p/--purge`               | `bool`    | Clean all caches/unnecessary files.  
+`-c/--clear`               | `string`  | Clean only the specified directories.<br>Options can be:<br> - `derived`: Derived Data. - `device`: iOS DeviceSupport (The latest iOS version will be kept.)<br> - `watch`: watchOS DeviceSupport<br> - `simulator`: 'CoreSimulator'<br> - `cache`: Xcode caches located at ```~/Library/Caches/com.apple.dt.Xcode```<br> - `archives`: Archives
+`-v/--version`             | `bool`    | Get the current version.
+
+## Development
+
+### Compiling from source
+    go get github.com/lajosdeme/xcclear
+If ```$GOPATH/bin``` is on your ```$PATH``` run ```xcclear -h``` to see usage options. 
+
+### Contributing
+If you have any suggestions or questions feel free to raise an issue or reach out to me directly via <a href="mailto:[email protected]">[email protected]</a>.  
+
+If this tool made your life easier you can thank me by buying me a coffee.  
+
+<a href="https://www.buymeacoffee.com/edgz29w" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+

go.mod

@@ -0,0 +1,9 @@
+module github.com/lajosdeme/xcclear
+
+go 1.14
+
+require (
+	github.com/Masterminds/semver v1.5.0
+	github.com/fatih/color v1.10.0
+	github.com/jessevdk/go-flags v1.5.0
+)

go.sum

@@ -0,0 +1,14 @@
+github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww=
+github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
+github.com/fatih/color v1.10.0 h1:s36xzo75JdqLaaWoiEHk767eHiwo0598uUxyfiPkDsg=
+github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
+github.com/jessevdk/go-flags v1.5.0 h1:1jKYvbxEjfUl0fmqTCOfonvskHHXMjBySTLW4y9LFvc=
+github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
+github.com/mattn/go-colorable v0.1.8 h1:c1ghPdyEDarC70ftn0y+A/Ee++9zz8ljHG1b13eJ0s8=
+github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4 h1:EZ2mChiOa8udjfp6rRmswTbtZN/QzUQp4ptM4rnjHvc=
+golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=