From c424ff5dd5f3440c98e2622aaddbd83cbde4674b Mon Sep 17 00:00:00 2001
From: Ian Wienand <iwienand@redhat.com>
Date: Fri, 1 Jun 2018 15:31:15 +1000
Subject: [PATCH] Update README

---
 README.rst | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.rst b/README.rst
index 69e130e..807c0a8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,36 @@
 afsmon
 ======
 
+Python library and utilities for monitoring AFS file-systems using
+`OpenAFS <https://www.openafs.org/>`__ tools.
+
+Many of the details are inspired by
+`<https://github.com/openafs-contrib/afs-tools>`__
+
+Command-line
+------------
+
+The ``afsmon`` tool provides
+
+ * ``show`` : produce tabular output of key statistics for a cell,
+   such as threads on file-servers, partition usage, volume usage and
+   quotas.
+
+ * ``statsd`` : report similar results to a `statsd
+   <https://github.com/etsy/statsd>`__ host.
+
+Configuration is minimal, see the ``sample.cfg``.
+
+Library
+-------
+
+The core of ``afsmon`` should suitable for use in other contexts.
+
+.. code-block:: python
+
+   import afsmon
+   fs = afsmon.FileServerStats('hostname')
+   fs.get_stats()
+
+The ``fs`` object now contains all available information for the
+server, partitions and volumes.