Lint README

Signed-off-by: Ondrej Vasko <[email protected]>
Lirt · Oct 4, 2022 · c6bc5af · c6bc5af
1 parent daacf8d
commit c6bc5af
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,16 @@
 # Prometheus Config Merger
 
-Sidecar to merge Prometheus from multiple ConfigMaps and save to file.
+Sidecar to merge Prometheus configuration from multiple ConfigMaps and save it to file.
 
 It is supposed to run as sidecar for Prometheus.
 
 ## How does it work
 
-1. Watch the changes to configmaps with specific label
-1. On any change get the contents from all watched ConfigMaps
-1. Merge the content together as yaml
-1. Write the yaml content to file
-1. Hit Prometheus reload API to reload the file
+1. Watch the changes to configmaps with specific label.
+1. On any change get the contents from all watched ConfigMaps.
+1. Merge the content together as yaml.
+1. Write the yaml content to file.
+1. Hit Prometheus reload API to reload the file.
 
 ## How to run
 
@@ -26,4 +26,4 @@ Run the program:
 
 ```bash
 python3 -m merger --prometheus-config-file-path 'my-test-config.yaml'
-```
+```
diff --git a/docs/README.md b/docs/README.md