Skip to content

Commit

Permalink
docs(readme): add toc to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
depado committed Mar 28, 2023
1 parent 1fad520 commit f655418
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# ginprom
<h1 align="center">Ginprom</h1>
<h2 align="center">

Gin Prometheus metrics exporter inspired by [github.com/zsais/go-gin-prometheus](https://github.com/zsais/go-gin-prometheus)

Expand All @@ -9,6 +10,25 @@ Gin Prometheus metrics exporter inspired by [github.com/zsais/go-gin-prometheus]
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Depado/bfchroma/blob/master/LICENSE)
[![godoc](https://godoc.org/github.com/Depado/ginprom?status.svg)](https://godoc.org/github.com/Depado/ginprom)

</h2>

- [Install](#install)
- [Differences with go-gin-prometheus](#differences-with-go-gin-prometheus)
- [Usage](#usage)
- [Options](#options)
- [Custom Counters](#custom-counters)
- [Custom gauges](#custom-gauges)
- [Path](#path)
- [Namespace](#namespace)
- [Subsystem](#subsystem)
- [Engine](#engine)
- [Prometheus Registry](#prometheus-registry)
- [Ignore](#ignore)
- [Token](#token)
- [Bucket size](#bucket-size)
- [Troubleshooting](#troubleshooting)
- [The instrumentation doesn't seem to work](#the-instrumentation-doesnt-seem-to-work)

## Install

Simply run:
Expand Down

0 comments on commit f655418

Please sign in to comment.