Add example on how the read variables can be used in build.gradle.kts

[mbe24]

If I have a file .env with

HOME=127.0.0.1

Should I just use System.getenv('HOME') to read the variable home? What is the way you intented?

Best,
Mike

[klahap]

Hi Mike,

Thank you for pointing that out! The README was outdated. Here's an updated example tailored to your use case:

import io.github.klahap.dotenv.DotEnvBuilder

val envVars = DotEnvBuilder.dotEnv {
    // addSystemEnv() // uncomment this line if you want to include system environment variables
    addFile("$rootDir/.env")
}

envVars.get("HOME") // = 127.0.0.1
// or
envVars.getOrThrow("HOME") // = 127.0.0.1

Please note that environment variables loaded this way are only accessible during the build process, such as in your build.gradle.kts. These variables will not be available at the runtime of the application.

Best regards,
Klaus