Skip to content

Commit 4b11e01

Browse files
committed
Update README
1 parent ce4484a commit 4b11e01

File tree

4 files changed

+37
-23
lines changed

4 files changed

+37
-23
lines changed

README.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,8 @@
33
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,
44
metrics, and logs) from any application.
55

6-
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.
7-
8-
> [!NOTE]
9-
> 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.
10-
11-
> [!IMPORTANT]
12-
> While the runner itself targets .NET 6 and later, the dashboard requires the .NET 8 runtime (or later) to run.
13-
>
14-
> 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.
15-
6+
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
7+
automatically download the dashboard if it's not installed, and will run and manage the dashboard process.
168

179
## [AspireRunner.Tool](./src/AspireRunner.Tool/README.md)
1810

@@ -22,7 +14,7 @@ Provides a quick and easy to use CLI for downloading and running the Dashboard
2214

2315
### Installation
2416

25-
```bash
17+
```console
2618
dotnet tool install -g AspireRunner.Tool
2719
```
2820

src/AspireRunner.AspNetCore/README.md

+23-7
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,40 @@ var builder = WebApplication.CreateBuilder(args);
1717
1818
if (builder.Environment.IsDevelopment())
1919
{
20+
// bind from configuration (appsettings.json, etc)
2021
builder.Services.AddAspireDashboard(config => {
21-
config.Otlp.EndpointUrl = "https://localhost:33554";
22-
23-
// Or bind from configuration (appsettings.json, etc)
2422
builder.Configuration.GetSection("AspireDashboard").Bind(config);
2523
});
26-
}
2724

28-
//...
25+
// or pass an options instance
26+
builder.Services.AddAspireDashboard(new AspireDashboardOptions
27+
{
28+
Frontend = new FrontendOptions
29+
{
30+
EndpointUrls = "https://localhost:5020"
31+
},
32+
Otlp = new OtlpOptions
33+
{
34+
EndpointUrl = "https://localhost:4317"
35+
},
36+
Runner = new RunnerOptions
37+
{
38+
AutoDownload = true
39+
}
40+
});
41+
}
2942

3043
var app = builder.Build();
3144

32-
//...
45+
// ...
46+
47+
await app.RunAsync();
3348
```
3449

3550
> [!NOTE]
3651
> The runner will prioritize using the dashboard bundled with
37-
> the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=linux&pivots=dotnet-cli), if it's installed.
52+
> 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
53+
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).
3854
3955
> [!IMPORTANT]
4056
> While the runner itself targets .NET 6 (and later), the dashboard requires the .NET 8/9 runtime to run.

src/AspireRunner.Core/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
This package contains the core functionality for running the Aspire Dashboard.
44

5-
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.
5+
The runner can be used as a [dotnet tool](https://www.nuget.org/packages/AspireRunner.Tool) or with
6+
the [ASP.NET Core extension](https://www.nuget.org/packages/AspireRunner.AspNetCore) which runs and manages the dashboard process alongside any ASP.NET app.
67
<hr>
78

89
The dashboard can be used to display OpenTelemetry data (traces, metrics and logs) from any
910
application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview))
1011

1112
> [!NOTE]
12-
> 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.
13+
> The runner will prioritize using the dashboard bundled with
14+
> 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
15+
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).
1316
1417
> [!IMPORTANT]
1518
> While the runner itself targets .NET 6 (and later), the dashboard requires the .NET 8/9 runtime to run.

src/AspireRunner.Tool/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
A dotnet tool for downloading and running the standalone [Aspire Dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/standalone)
44

5-
The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)).
5+
The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any
6+
application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)).
67

78
[![NuGet Version](https://img.shields.io/nuget/vpre/AspireRunner.Tool?style=flat&logo=nuget&color=%230078d4&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FAspireRunner.Tool)](https://www.nuget.org/packages/AspireRunner.Tool)
89

@@ -14,7 +15,7 @@ dotnet tool install -g AspireRunner.Tool
1415

1516
## Usage
1617

17-
```
18+
```console
1819
aspire-dashboard <options>
1920

2021
Options:
@@ -48,4 +49,6 @@ Options:
4849
```
4950

5051
> [!NOTE]
51-
> 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.
52+
> The runner will prioritize using the dashboard bundled with
53+
> 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
54+
> download the dashboard to the user's `.dotnet` directory (`~/.dotnet/.AspireRunner`).

0 commit comments

Comments
 (0)