From e7e1b10db153cfa8428ecafdaea32c28b5295fea Mon Sep 17 00:00:00 2001 From: Oisin Grehan Date: Thu, 26 Dec 2024 14:06:22 -0500 Subject: [PATCH] Update README.md add status badges and links --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eca60d8..66f2115 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -# Aspire Project Commander +[![publish](https://github.com/oising/AspireProjectCommander/actions/workflows/main.yml/badge.svg)](https://github.com/oising/AspireProjectCommander/actions/workflows/main.yml) +# Aspire Project Commander -Version: 1.0.0-beta1 +![icon](https://github.com/user-attachments/assets/a087a57f-63fe-43f6-ad72-e774eef86236) Aspire Project commander is a set of packages that lets you send simple string commands from the dashboard directly to projects. +## NuGet Packages + +|Type|Name|Status| +|-|-|-| +|Integration|`Nivot.Aspire.ProjectCommander`|[![NuGet pre version](https://badgen.net/nuget/v/Nivot.Aspire.ProjectCommander/pre)](https://www.nuget.org/packages/Nivot.Aspire.ProjectCommander)| +|Hosting|`Nivot.Aspire.Hosting.ProjectCommander`|[![NuGet pre version](https://badgen.net/nuget/v/Nivot.Aspire.Hosting.ProjectCommander/pre)](https://www.nuget.org/packages/Nivot.Aspire.Hosting.ProjectCommander)| + ## Custom Resource Commands [Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/) allows adding [custom commands](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/custom-resource-commands) to any project in the dashboard but these commands are scoped to and handled in the AppHost itself. These are useful to send commands to APIs on running containers, such as performing a `FLUSHALL` on a Redis container to reset state. Ultimately, the `WithCommand` resource extension method requires you to interface with each target resource (e.g. `Executable`, `Container`, `Project`) independently, using code you write yourself.