updated readme

README.md

@@ -1,6 +1,8 @@
-# Simple AWS SQS exporter
+# AWS SQS Prometheus Exporter
 
-A Prometheus SQS metrics exporter
+A Prometheus metrics exporter for AWS SQS queues
+
+> **A few words of Thanks:** Most of the code in this repo is borrowed from [ashiddo11/sqs-exporter](https://github.com/ashiddo11/sqs-exporter) with bundle of thanks and love :pray: :heart:. I didn't submit this as a pull request to the original repository, since I have added Prometheus client. Whereas, some users of the original repository may not be using Prometheus at all. 
 
 ## Metrics
 
@@ -47,11 +49,19 @@ The app needs sqs list and read access to the sqs policies
 }
 ```
 
+## Environment Variables
+| Variable      | Default Value | Description                                                  |
+|---------------|:---------|:-------------------------------------------------------------|
+| PORT          | 9434     | The port for metrics server                                  |
+| INTERVAL      | 1        | The interval in minutes to get the status of SQS queues      |
+| ENDPOINT      | metrics  | The metrics endpoint                                         |
+| KEEP_RUNNING  | true     | The flag to terminate the service in case of monitoring error |
+
+
 ## Running
 
-**You need to specify the region you to connect to**
-Running on an ec2 machine using IAM roles:
-`docker run -e AWS_REGION=<region> -d -p 9434:9434 ashiddo11/sqs-exporter`
+```docker run -e INTERVAL=5 -e KEEP_RUNNING=false -d -p 9434:9434 nadeemjamali/sqs-prometheus-exporter```
+
+You can provide the AWS credentials as environment variables depending upon your security rules configured in AWS;
 
-Or running it externally:
-`docker run -d -p 9384:9384 -e AWS_ACCESS_KEY_ID=<access_key> -e AWS_SECRET_ACCESS_KEY=<secret_key> -e AWS_REGION=<region>  ashiddo11/sqs-exporter`
+```docker run -d -p 9384:9384 -e AWS_ACCESS_KEY_ID=<access_key> -e AWS_SECRET_ACCESS_KEY=<secret_key> -e AWS_REGION=<region>  nadeemjamali/sqs-prometheus-exporter```