From 8b54b70651c8b0aa6a1bae6f13354361dfd9982f Mon Sep 17 00:00:00 2001 From: Serge K Date: Fri, 13 Dec 2024 14:46:23 +0700 Subject: [PATCH] update readme --- .../workflows/{ci-windows-only.yml => ci.yml} | 0 README.md | 33 ++++++++++--------- 2 files changed, 18 insertions(+), 15 deletions(-) rename .github/workflows/{ci-windows-only.yml => ci.yml} (100%) diff --git a/.github/workflows/ci-windows-only.yml b/.github/workflows/ci.yml similarity index 100% rename from .github/workflows/ci-windows-only.yml rename to .github/workflows/ci.yml diff --git a/README.md b/README.md index a11dee4..faaa3a9 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,36 @@ # Prometheus.Client.Owin -[![NuGet](https://img.shields.io/nuget/v/Prometheus.Client.Owin.svg)](https://www.nuget.org/packages/Prometheus.Client.Owin) -[![NuGet](https://img.shields.io/nuget/dt/Prometheus.Client.Owin.svg)](https://www.nuget.org/packages/Prometheus.Client.Owin) -[![License MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT) +[![ci](https://img.shields.io/github/actions/workflow/status/prom-client-net/prom-client-owin/ci.yml?branch=main&label=ci&logo=github&style=flat-square)](https://github.com/prom-client-net/prom-client-owin/actions/workflows/ci.yml) +[![nuget](https://img.shields.io/nuget/v/Prometheus.Client.Owin?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Prometheus.Client.Owin) +[![nuget](https://img.shields.io/nuget/dt/Prometheus.Client.Owin?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Prometheus.Client.Owin) +[![license](https://img.shields.io/github/license/prom-client-net/prom-client-owin?style=flat-square)](https://github.com/prom-client-net/prom-client-owin/blob/main/LICENSE) + Extension for [Prometheus.Client](https://github.com/PrometheusClientNet/Prometheus.Client) -#### Installation: +## Installation - dotnet add package Prometheus.Client.Owin - -#### Use +```sh +dotnet add package Prometheus.Client.Owin +``` -There are [Examples](https://github.com/PrometheusClientNet/Prometheus.Client.Examples/tree/net45-support/Middleware/WebOwin_4.5) +### Use -```csharp +[Examples](https://github.com/prom-client-net/prom-examples) +```c# public void Configuration(IAppBuilder app) -{ - app.UsePrometheusServer(); +{ + app.UsePrometheusServer(); } ``` -or -```csharp + +```c# public void Configuration(IAppBuilder app) -{ +{ app.UsePrometheusServer(q => { q.MapPath = "/api/metrics"; }); } - ``` +```