Doc: add package docs (#296)

* Doc: add package docs

Add short package level docs to make godoc looks nicer.
Add some badges to the README.

* correct url

middleware/metrics/metrics.go

@@ -1,3 +1,5 @@
+// Package metrics implement a handler and middleware that provides Prometheus
+// metrics.
 package metrics
 
 import (