Skip to content

Commit 88fcdc5

Browse files
authored
docs: polish README with full badge row + NuGet links + Related Repositories (#60)
Brings the README into line with the cool xavierjohn/Trellis main-repo README pattern + reflects today's repo rename: - Title bumped from "Service Level Indicators" to "Trellis.ServiceLevelIndicators" to match the new repo name + the canonical NuGet package family. - Badge row at top: Build status (with corrected post-rename URL), NuGet version badge per package (3 packages: core, .Asp, .Asp.ApiVersioning), cumulative NuGet downloads, License (MIT), .NET 10.0, C# 14.0, GitHub stars. - Tagline blockquote restating the one-line value proposition (latency SLI library, OpenTelemetry-backed, rich dimensions). - Intro sentence rewritten to lead with `Trellis.ServiceLevelIndicators` (the canonical name) rather than the bare-name prefix. - Related repositories section appended cross-linking the rest of the Trellis family (main framework, Microservices, Microservices.Template, AspTemplate). No code or doc-content changes; README only.
1 parent 7f3e6ce commit 88fcdc5

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1-
# Service Level Indicators
1+
# Trellis.ServiceLevelIndicators
22

3-
[![Build](https://github.com/xavierjohn/ServiceLevelIndicators/actions/workflows/build.yml/badge.svg)](https://github.com/xavierjohn/ServiceLevelIndicators/actions/workflows/build.yml)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3+
[![Build](https://github.com/xavierjohn/Trellis.ServiceLevelIndicators/actions/workflows/build.yml/badge.svg)](https://github.com/xavierjohn/Trellis.ServiceLevelIndicators/actions/workflows/build.yml)
4+
[![NuGet: Trellis.ServiceLevelIndicators](https://img.shields.io/nuget/v/Trellis.ServiceLevelIndicators.svg?label=Trellis.ServiceLevelIndicators)](https://www.nuget.org/packages/Trellis.ServiceLevelIndicators)
5+
[![NuGet: Asp](https://img.shields.io/nuget/v/Trellis.ServiceLevelIndicators.Asp.svg?label=Trellis.ServiceLevelIndicators.Asp)](https://www.nuget.org/packages/Trellis.ServiceLevelIndicators.Asp)
6+
[![NuGet: ApiVersioning](https://img.shields.io/nuget/v/Trellis.ServiceLevelIndicators.Asp.ApiVersioning.svg?label=Trellis.ServiceLevelIndicators.Asp.ApiVersioning)](https://www.nuget.org/packages/Trellis.ServiceLevelIndicators.Asp.ApiVersioning)
7+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Trellis.ServiceLevelIndicators.svg)](https://www.nuget.org/packages/Trellis.ServiceLevelIndicators)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
9+
[![.NET](https://img.shields.io/badge/.NET-10.0-purple.svg)](https://dotnet.microsoft.com/download)
10+
[![C#](https://img.shields.io/badge/C%23-14.0-blue.svg)](https://docs.microsoft.com/en-us/dotnet/csharp/)
11+
[![GitHub Stars](https://img.shields.io/github/stars/xavierjohn/Trellis.ServiceLevelIndicators?style=social)](https://github.com/xavierjohn/Trellis.ServiceLevelIndicators/stargazers)
512

6-
ServiceLevelIndicators is a .NET library for emitting service-level latency metrics in milliseconds using the standard [System.Diagnostics.Metrics](https://learn.microsoft.com/dotnet/api/system.diagnostics.metrics) and OpenTelemetry pipeline.
13+
> Latency SLI library for .NET: emits operation-duration histograms via `System.Diagnostics.Metrics` + OpenTelemetry, with rich dimensions (CustomerResourceId, LocationId, Operation, Outcome) and ASP.NET Core + API-versioning integrations.
14+
15+
`Trellis.ServiceLevelIndicators` is a .NET library for emitting service-level latency metrics in milliseconds using the standard [System.Diagnostics.Metrics](https://learn.microsoft.com/dotnet/api/system.diagnostics.metrics) and OpenTelemetry pipeline.
716

817
It is designed for teams that need more than generic request timing. The library helps measure meaningful operations, attach service-specific dimensions such as customer, location, operation name, and SLI outcome, and build SLO or SLA-oriented dashboards and alerts from those metrics.
918

@@ -344,3 +353,14 @@ To view the metrics locally using the [.NET Aspire Dashboard](https://aspire.dev
344353
![SLI](assets/aspire.jpg)
345354
4. If you run the sample with API Versioning, you will see something similar to the following.
346355
![SLI](assets/versioned.jpg)
356+
357+
## Related repositories
358+
359+
- [`xavierjohn/Trellis`](https://github.com/xavierjohn/Trellis) — the framework: `Result<T>`, `Maybe<T>`, value objects, DDD primitives, ASP.NET / EF Core / Mediator integration. SLI metrics integrate naturally with Trellis pipeline behaviors.
360+
- [`xavierjohn/Trellis.Microservices`](https://github.com/xavierjohn/Trellis.Microservices) — microservice trust-boundary packages: YARP gateway minting internal JWTs + consumer-side actor provider.
361+
- [`xavierjohn/Trellis.Microservices.Template`](https://github.com/xavierjohn/Trellis.Microservices.Template) — `dotnet new trellis-microservices` Project Tracker starter.
362+
- [`xavierjohn/Trellis.AspTemplate`](https://github.com/xavierjohn/Trellis.AspTemplate) — `dotnet new trellis-asp` single-service Clean Architecture template.
363+
364+
## License
365+
366+
[MIT](LICENSE).

0 commit comments

Comments
 (0)