From 307deac3ed291fce9a0003f4cd1b88e3b763d81e Mon Sep 17 00:00:00 2001
From: Ed Schouten <ed@kumina.nl>
Date: Fri, 17 Feb 2017 16:04:32 +0100
Subject: [PATCH] Add a simple README.

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0c4744
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Prometheus Postfix exporter
+
+This repository provides code for a simple Prometheus metrics exporter
+for [the Postfix mail server](http://www.postfix.org/). Right now, this
+exporter only provides histogram metrics for the size and age of
+messages stored in the mail queue. It extracts these metrics from
+Postfix by connecting to a UNIX socket under `/var/spool`.
+
+Please refer to this utility's `main()` function for a list of supported
+command line flags.