docs: adding some bl to readme

Author: Ricardo Lüders

README.md

@@ -1,6 +1,8 @@
 # Insights Operator
 
-This cluster operator gathers anonymized system configuration and reports it to Red Hat Insights. It is a part of the standard OpenShift distribution. The data collected allows for debugging in the event of cluster failures or unanticipated errors.
+This cluster operator gathers anonymized system configuration and reports it to Red Hat Insights. It is a part of the 
+standard OpenShift distribution. The data collected allows for debugging in the event of cluster failures or 
+unanticipated errors.
 
 # Table of Contents
 
@@ -58,7 +60,8 @@ Unit tests can be started by the following command:
 make test
 ```
 
-It is also possible to specify CLI options for Go test. For example, if you need to disable test results caching, use the following command:
+It is also possible to specify CLI options for Go test. For example, if you need to disable test results caching, 
+use the following command:
 
 ```shell script
 VERBOSE=-count=1 make test
@@ -69,7 +72,9 @@ VERBOSE=-count=1 make test
 # Documentation
 
 
-The document [docs/gathered-data](docs/gathered-data.md) contains the list of collected data and the API that is used to collect it. This documentation is generated by the command bellow, by collecting the comment tags located above each Gather method.
+The document [docs/gathered-data](docs/gathered-data.md) contains the list of collected data and the API that is used 
+to collect it. This documentation is generated by the command bellow, by collecting the comment tags located above 
+each Gather method.
 
 To start generating the document run:
 
@@ -81,23 +86,29 @@ make docs
 
 ## Generate the certificate and key
 
-Certificate and key are required to access Prometheus metrics (instead 404 Forbidden is returned). It is possible to generate these two files from Kubernetes config file. Certificate is stored in `users/admin/client-cerfificate-data` and key in `users/admin/client-key-data`. Please note that these values are encoded by using Base64 encoding, so it is needed to decode them, for example by `base64 -d`.
+Certificate and key are required to access Prometheus metrics (instead 404 Forbidden is returned). It is possible 
+to generate these two files from Kubernetes config file. Certificate is stored in `users/admin/client-cerfificate-data` 
+and key in `users/admin/client-key-data`. Please note that these values are encoded by using Base64 encoding, 
+so it is needed to decode them, for example by `base64 -d`.
 
-There's a tool named `gen_cert_key.py` that can be used to automatically generate both files. It is stored in `tools` subdirectory.
+There's a tool named `gen_cert_key.py` that can be used to automatically generate both files. It is stored in `tools` 
+subdirectory.
 
 ```shell script
 gen_cert_file.py kubeconfig.yaml
 ```
 
 ## Prometheus metrics provided by Insights Operator
 
-It is possible to read Prometheus metrics provided by Insights Operator. Example of metrics exposed by Insights Operator can be found at [metrics.txt](docs/metrics.txt)
+It is possible to read Prometheus metrics provided by Insights Operator. Example of metrics exposed by 
+Insights Operator can be found at [metrics.txt](docs/metrics.txt)
 
-Depending on how or where the IO is running you may have different ways to retrieve the metrics. Here is a list of some options, so you can find the one that fits you:
+Depending on how or where the IO is running you may have different ways to retrieve the metrics. 
+Here is a list of some options, so you can find the one that fits you:
 
 ### Running IO locally
 
-If the IO runs locally, the following command migth be used:
+If the IO runs locally, the following command might be used:
 
 ```shell script
 curl --cert k8s.crt --key k8s.key -k https://localhost:8443/metrics
@@ -174,7 +185,8 @@ go tool pprof http://localhost:6060/debug/pprof/profile?seconds=30
 go tool pprof http://localhost:6060/debug/pprof/heap
 ```
 
-These commands will create a compressed file that can be visualized using a variety of tools, one of them is the `pprof` tool.
+These commands will create a compressed file that can be visualized using a variety of tools, one of them is 
+the `pprof` tool.
 
 ### Analyzing profiling data
 
@@ -201,15 +213,17 @@ It uses both the local git and GitHub`s API to update the file so:
 
 It can be used 2 ways:
 
-1. Providing no command line arguments the script will update the current `CHANGELOG.md` with the latest changes according to the local git state.
+1. Providing no command line arguments the script will update the current `CHANGELOG.md` with the latest changes 
+2. according to the local git state.
 
 > 🚨 IMPORTANT: It will only work with changelogs created with this script
 
 ```shell script
 go run cmd/changelog/main.go
 ```
 
-2. Providing 2 command line arguments, `AFTER` and `UNTIL` dates the script will generate a new `CHANGELOG.md` within the provided time frame.
+2. Providing 2 command line arguments, `AFTER` and `UNTIL` dates the script will generate a new `CHANGELOG.md` within 
+the provided time frame.
 
 ```shell script
 go run cmd/changelog/main.go 2021-01-10 2021-01-20
@@ -221,15 +235,18 @@ go run cmd/changelog/main.go 2021-01-10 2021-01-20
 * ClusterOperator objects
 * All non-secret global config (hostnames and URLs anonymized)
 
-The list of all collected data with description, location in produced archive and link to Api and some examples is at [docs/gathered-data.md](docs/gathered-data.md)
+The list of all collected data with description, location in produced archive and link to Api and some examples is 
+at [docs/gathered-data.md](docs/gathered-data.md)
 
-The resulting data is packed in `.tar.gz` archive with folder structure indicated in the document. Example of such archive is at [docs/insights-archive-sample](docs/insights-archive-sample).
+The resulting data is packed in `.tar.gz` archive with folder structure indicated in the document. Example of such 
+archive is at [docs/insights-archive-sample](docs/insights-archive-sample).
 
 ## Insights Operator Archive
 
 ### Sample IO archive
 
-There is a sample IO archive maintained in this repo to use as a quick reference. (can be found at [docs/insights-archive-sample](https://github.com/openshift/insights-operator/tree/master/docs/insights-archive-sample))
+There is a sample IO archive maintained in this repo to use as a quick reference. (can be found 
+at [docs/insights-archive-sample](https://github.com/openshift/insights-operator/tree/master/docs/insights-archive-sample))
 
 To keep it up-to-date it is **required** to update this manually when developing a new data enhancement.