diff --git a/README.md b/README.md index 88ec94d..6a615d4 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,8 @@ A standalone runner for the .NET [Aspire Dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/standalone) which can display OpenTelemetry data (traces, metrics, and logs) from any application. -The runner can be used as a [dotnet tool](./src/AspireRunner.Tool/README.md) or as part of an [ASP.NET Core application](./src/AspireRunner.AspNetCore/README.md), it will automatically download the dashboard if it's not installed, and will run and manage the dashboard process. - -> [!NOTE] -> The runner will prioritize using the dashboard bundled with the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed. - -> [!IMPORTANT] -> While the runner itself targets .NET 6 and later, the dashboard requires the .NET 8 runtime (or later) to run. -> -> Meaning that the runner can be used as part of a .NET 6 application, but you'll still need the .NET 8 runtime to run the dashboard. - +The runner can be used as a [dotnet tool](./src/AspireRunner.Tool/README.md) or as part of an [ASP.NET Core application](./src/AspireRunner.AspNetCore/README.md), it will +automatically download the dashboard if it's not installed, and will run and manage the dashboard process. ## [AspireRunner.Tool](./src/AspireRunner.Tool/README.md) @@ -22,7 +14,7 @@ Provides a quick and easy to use CLI for downloading and running the Dashboard ### Installation -```bash +```console dotnet tool install -g AspireRunner.Tool ``` diff --git a/src/AspireRunner.AspNetCore/README.md b/src/AspireRunner.AspNetCore/README.md index 2e66108..76002fe 100644 --- a/src/AspireRunner.AspNetCore/README.md +++ b/src/AspireRunner.AspNetCore/README.md @@ -17,24 +17,40 @@ var builder = WebApplication.CreateBuilder(args); if (builder.Environment.IsDevelopment()) { + // bind from configuration (appsettings.json, etc) builder.Services.AddAspireDashboard(config => { - config.Otlp.EndpointUrl = "https://localhost:33554"; - - // Or bind from configuration (appsettings.json, etc) builder.Configuration.GetSection("AspireDashboard").Bind(config); }); -} -//... + // or pass an options instance + builder.Services.AddAspireDashboard(new AspireDashboardOptions + { + Frontend = new FrontendOptions + { + EndpointUrls = "https://localhost:5020" + }, + Otlp = new OtlpOptions + { + EndpointUrl = "https://localhost:4317" + }, + Runner = new RunnerOptions + { + AutoDownload = true + } + }); +} var app = builder.Build(); -//... +// ... + +await app.RunAsync(); ``` > [!NOTE] > The runner will prioritize using the dashboard bundled with -> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed. +> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli) if it's installed, otherwise, The runner will +> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`). > [!IMPORTANT] > While the runner itself targets .NET 6 (and later), the dashboard requires the .NET 8/9 runtime to run. diff --git a/src/AspireRunner.Core/README.md b/src/AspireRunner.Core/README.md index f6b1dcb..c639ed5 100644 --- a/src/AspireRunner.Core/README.md +++ b/src/AspireRunner.Core/README.md @@ -2,14 +2,17 @@ This package contains the core functionality for running the Aspire Dashboard. -The runner can be used as a [dotnet tool](https://www.nuget.org/packages/AspireRunner.Tool) or with the [ASP.NET Core extension](https://www.nuget.org/packages/AspireRunner.AspNetCore) which runs and manages the dashboard process alongside any ASP.NET app. +The runner can be used as a [dotnet tool](https://www.nuget.org/packages/AspireRunner.Tool) or with +the [ASP.NET Core extension](https://www.nuget.org/packages/AspireRunner.AspNetCore) which runs and manages the dashboard process alongside any ASP.NET app.