Merge pull request #1 from cycloidio/sd_readme

report: Improve README

report/README.md

@@ -1,25 +1,25 @@
 # Reports
 
-Scripts used to provide report to cycloid.
+Scripts used to provide useful debug report to the Cycloid team.
 
 # Contribution
 
 Global functions are located under `source/common.sh`.
-Please use the `generate.sh` script to update the `generated/*_report.sh` script
+Please use the `generate.sh` script to update `generated/*_report.sh` ones.
 
 ```
 ./generate.sh
 ```
 
 # Details
 
-* **worker_report.sh**: Generate report from concourse worker and provide a url + secret.
-* **onprem_report.sh**: Generate report from cycloid onprem setup and provide a url + secret.
-* **getreport.sh**: Get report from provided url + secret.
+* **worker_report.sh**: Generate report from Concourse worker and provide a URL + secret.
+* **onprem_report.sh**: Generate report from Cycloid onprem setup and provide a URL + secret.
+* **getreport.sh**: Get report from provided URL + secret.
 
 ## worker_report.sh
 
-The script generate a full report of the concourse worker.
+The script generate a full report of a Concourse worker.
 
 **functions list**
 
@@ -43,13 +43,13 @@ The script generate a full report of the concourse worker.
 
 ### Usage
 ```
-curl -s https://raw.githubusercontent.com/cycloidio/cycloid-utils/master/report/generated/worker_report.sh | sudo bash
+curl -sSL https://raw.githubusercontent.com/cycloidio/cycloid-utils/master/report/generated/worker_report.sh | sudo bash
 ```
 
 
 ## onprem_report.sh
 
-The script generate a full report of the cycloid onprem setup.
+The script generate a full report of a Cycloid on-premise setup.
 
 **functions list**
 
@@ -69,23 +69,23 @@ The script generate a full report of the cycloid onprem setup.
 
 ### Usage
 ```
-curl -s https://raw.githubusercontent.com/cycloidio/cycloid-utils/master/report/generated/onprem_report.sh | sudo bash
+curl -sSL https://raw.githubusercontent.com/cycloidio/cycloid-utils/master/report/generated/onprem_report.sh | sudo bash
 ```
 
 
 ## getreport.sh
 
 This script is used to get the report generated by the previous scripts.
-Customer need to provide the url and secret generated.
+Customer need to provide the URL and secret generated.
 
 **functions list**
 
-  * Download report from the provided url
-  * GPG Decrypt the archive with the provided secret
-  * Extract the archive in `/tmp/debug`
+  * Download report from the provided URL.
+  * GPG Decrypt the archive with the provided secret.
+  * Extract the archive in `/tmp/debug`.
 
 ### Usage
 
 ```
-./generate.sh <https_url> <secret>
+./getreport.sh <https_url> <secret>
 ```