diff --git a/README.md b/README.md index 9880010..eb6f071 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,9 @@ You will need the following: * [Rust Compiler](https://www.rust-lang.org/tools/install) -When running the API locally, it does support the use of a `.env` file for providing Environment Variables. +When running the API locally, it does support the use of a `.env` file at the root of the project for providing [Environment Variables](https://github.com/liatrio/liatrio-dora-api/tree/main?tab=readme-ov-file#environment-variables). + +If you are unfamiliar with Rust, you can build the application using `cargo build` and run the application using `cargo run`. # Usage @@ -79,4 +81,4 @@ If you are using Loki DB for your metrics storage, you will need the following: Optionally, if you have secured the REST API on your Loki DB, you will need to provide the following: * **LOKI_USER**: The user for the Loki database -* **LOKI_TOKEN**: The token for the Loki database \ No newline at end of file +* **LOKI_TOKEN**: The token for the Loki database