From a331f1ea4a8d2fe7aaca206ce7e9fee0593f01be Mon Sep 17 00:00:00 2001 From: Brian Brazil Date: Thu, 15 Feb 2018 11:43:22 +0000 Subject: [PATCH] Add Godoc link at the top of the README For those following that link, make it more obvious which subpackage they probably want. --- README.md | 1 + prometheus/doc.go | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0d0156d..17d46ec 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://travis-ci.org/prometheus/client_golang.svg?branch=master)](https://travis-ci.org/prometheus/client_golang) [![Go Report Card](https://goreportcard.com/badge/github.com/prometheus/client_golang)](https://goreportcard.com/report/github.com/prometheus/client_golang) +[![go-doc](https://godoc.org/github.com/prometheus/client_golang?status.svg)](https://godoc.org/github.com/prometheus/client_golang) This is the [Go](http://golang.org) client library for [Prometheus](http://prometheus.io). It has two separate parts, one for diff --git a/prometheus/doc.go b/prometheus/doc.go index 36ef155..f727c99 100644 --- a/prometheus/doc.go +++ b/prometheus/doc.go @@ -11,10 +11,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package prometheus provides metrics primitives to instrument code for -// monitoring. It also offers a registry for metrics. Sub-packages allow to -// expose the registered metrics via HTTP (package promhttp) or push them to a -// Pushgateway (package push). +// Package prometheus is the core instrumentation package. It provides metrics +// primitives to instrument code for monitoring. It also offers a registry for +// metrics. Sub-packages allow to expose the registered metrics via HTTP +// (package promhttp) or push them to a Pushgateway (package push). // // All exported functions and methods are safe to be used concurrently unless // specified otherwise.