diff --git a/README.md b/README.md index b19f812..3934654 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,18 @@ gradlew build docker compose up ``` +## Configuration +If wished, you can modify the configuration of the `docker-compose.yaml` file to fit your need. + +The container `application` can be easily modified with the following environment variables : + +| Name | Required | Format | Default | Description | +|------------------------------|----------|-----------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------| +| KAFKA_BOOTSTRAP_SERVERS | true | \[:port] | / | The Kafka server address | +| TOPIC_TEMPERATURE_CELSIUS | false | string of alphanumeric characters, ".", "_" and "-" | temperature-celsius | The name of the Kafka topic for the temperature in Celsius | +| TOPIC_TEMPERATURE_FAHRENHEIT | false | string of alphanumeric characters, ".", "_" and "-" | temperature-fahrenheit | The name of the Kafka topic for the temperature in Fahrenheit | | +| TEMPERATURE_LOCATION | true | \, \ | 49.9, 2.3 ([Amiens, France](https://fr.wikipedia.org/wiki/Amiens)) | The coordinates were to get the temperatures from | + ## Expectation -The `application` container shall print the current temperature at the selected place in -Fahrenheit every minute. +The `application` container shall print the current temperature at the selected place in +Fahrenheit every minute. \ No newline at end of file