Update README to include missing make target descriptions (kuskoman#145)

--------- Co-authored-by: Jakub Surdej <kubasurdej@gmail.com>
xonvanetta · Jul 4, 2023 · ad4eb46 · ad4eb46
1 parent 289f581
commit ad4eb46
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -106,13 +106,16 @@ All configuration variables can be checked in the [config directory](./config/).
 - `make build-docker-multi`: Builds a multi-arch Docker image (`amd64` and `arm64`) for the Go Exporter application.
 - `make clean`: Deletes all binary executables in the out directory.
 - `make test`: Runs all tests.
+- `make test-coverage`: Displays test coverage report.
 - `make compose`: Starts a Docker-compose configuration.
 - `make wait-for-compose`: Starts a Docker-compose configuration and waits for it to be ready.
 - `make compose-down`: Stops a Docker-compose configuration.
 - `make verify-metrics`: Verifies the metrics from the Go Exporter application.
 - `make pull`: Pulls the Docker image from the registry.
 - `make logs`: Shows logs from the Docker-compose configuration.
 - `make minify`: Minifies the binary executables.
+- `make install-helm-readme`: Installs readme-generator-for-helm tool.
+- `make helm-readme`: Generates Helm chart README.md file.
 - `make help`: Shows the available commands.
 
 #### File Structure
@@ -150,6 +153,10 @@ Run all tests:
 
     make test
 
+Display test coverage report:
+
+    make test-coverage 
+
 Start the Docker-compose configuration:
 
     make compose
@@ -178,6 +185,14 @@ Minify the binary executables:
 
     make minify
 
+Install readme-generator-for-helm tool:
+
+    make install-helm-readme
+
+Generate Helm chart README.md file:
+
+    make helm-readme
+
 Show the available commands:
 
     make help