From d5cbd64f949903a6d2e3efabfd2cb60e364bbc6e Mon Sep 17 00:00:00 2001 From: Rob Best Date: Wed, 5 May 2021 22:48:04 +0100 Subject: [PATCH] Update README.md - Remove TOC (Github provides one) - Add quicker links at the top of the doc --- README.md | 37 ++++++++----------------------------- 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 264aa73..2450bd8 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,14 @@ # SSL Certificate Exporter -Exports metrics for certificates collected from TCP probes, local files or -Kubernetes secrets. The metrics are labelled with fields from the certificate, -which allows for informational dashboards and flexible alert routing. +Exports metrics for certificates collected from various sources: +- [TCP probes](#tcp) +- [HTTPS probes](#https) +- [PEM files](#file) +- [Kubernetes secrets](#kubernetes) +- [Kubeconfig files](#kubeconfig) -## Table of Contents - -- [SSL Certificate Exporter](#ssl-certificate-exporter) - - [Table of Contents](#table-of-contents) - - [Building](#building) - - [Docker](#docker) - - [Release process](#release-process) - - [Usage](#usage) - - [Metrics](#metrics) - - [Configuration](#configuration) - - [TCP](#tcp) - - [HTTPS](#https) - - [File](#file) - - [Kubernetes](#kubernetes) - - [Kubeconfig](#kubeconfig) - - [Configuration file](#configuration-file) - - [<module>](#module) - - [<tls_config>](#tls_config) - - [<https_probe>](#https_probe) - - [<tcp_probe>](#tcp_probe) - - [<kubernetes_probe>](#kubernetes_probe) - - [Example Queries](#example-queries) - - [Peer Certificates vs Verified Chain Certificates](#peer-certificates-vs-verified-chain-certificates) - - [Grafana](#grafana) - -Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) +The metrics are labelled with fields from the certificate, which allows for +informational dashboards and flexible alert routing. ## Building