From 61770d5c86547bf88609731e931badbc345fb360 Mon Sep 17 00:00:00 2001 From: Serge K Date: Fri, 13 Dec 2024 16:17:36 +0700 Subject: [PATCH] update readme --- README.md | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a11dee4..e05cfff 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,47 @@ # 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"; }); } - ``` +``` + +## Contribute + +Contributions to the package are always welcome! + +* Report any bugs or issues you find on the [issue tracker](https://github.com/prom-client-net/prom-client-owin/issues). +* You can grab the source code at the package's [git repository](https://github.com/prom-client-net/prom-client-owin). + +## License + +All contents of this package are licensed under the [MIT license](https://opensource.org/licenses/MIT).