Updating readme.md

README.md

@@ -14,6 +14,29 @@ This is a Symfony bridge for the framework agnostic [Correlation ID library](htt
  * [The value of a correlation ID](https://blog.rapid7.com/2016/12/23/the-value-of-correlation-ids/)
  * [Identity Correlation on Wikipedia](https://en.wikipedia.org/wiki/Identity_correlation)
 
+## Installation
+
+```sh
+composer require phauthentic/correlation-id-symfony-bundle
+```
+
+## Configuration
+
+You can configure three different settings to control the behavior:
+
+* `response_header_name` - The name of the response header for the ID.
+* `request_header_name` - The name of the request header for the ID.
+* `pass_through` - If the ID from the request should be passed to the response enable this. This is useful if you are dealing with a microservice that is not exposed to the public but gets further actions delegated from the entry point and must retain the original ID.
+
+`config/correlation_id.yaml`:
+
+```yaml
+correlation_id:
+    response_header_name: 'X-Correlation-ID'
+    request_header_name: 'X-Correlation-ID'
+    pass_through: false
+```
+
 ## Copyright & License
 
 Licensed under the [MIT license](LICENSE).