From 5b52fca006d620049929e38f131470afd543e919 Mon Sep 17 00:00:00 2001 From: Benziza Date: Thu, 17 Sep 2026 21:46:16 +0200 Subject: [PATCH] Document NuGet tool installation --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8ad4dda..6c2cdaf 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,21 @@ See which .NET configuration source set a value, and which values it replaced. ![Animated demo of whyconfig explaining Database:Host](assets/whyconfig-demo.gif) -## Try it +## Install -Requires the .NET 10 SDK. From this repository, run: +Requires the .NET 10 SDK. ```bash -dotnet run --project src/WhyConfig.Cli -- explain Database:Host --project path/to/YourApp --environment Development +dotnet tool install -g WhyConfig.NET ``` -The CLI checks the project's `appsettings` files, Development User Secrets, and current environment variables. Run `dotnet run --project src/WhyConfig.Cli -- --help` for options. +## Use + +```bash +whyconfig explain Database:Host --project path/to/YourApp --environment Development +``` + +The CLI checks the project's `appsettings` files, Development User Secrets, and current environment variables. Run `whyconfig --help` for options. For the exact configuration of a running app, use `WhyConfig.Core` with its `IConfigurationRoot`: