From 6edf6cf93f278d1249103a9bc81c6473e22c0162 Mon Sep 17 00:00:00 2001
From: heavenshell <heavenshell.jp@gmail.com>
Date: Sun, 8 Mar 2015 21:10:13 +0900
Subject: [PATCH] Add cli document.

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

diff --git a/README.rst b/README.rst
index e42ce1e..023da49 100644
--- a/README.rst
+++ b/README.rst
@@ -112,3 +112,38 @@ Post service metrics
   # Post 'custom.metrics.latency' and 'custom.metrics.uptime' to `service_name`.
   self.client.post_service_metrics('service_name', metrics)
 
+
+CLI
+---
+
+Get host(s) information from hostname or service, role.
+
+.. code:: shell
+
+  $ mkr.py info [--name foo] [--service service] [--role role]
+
+Set status of a host.
+
+.. code:: shell
+
+  $ mkr.py status --host-id foo --status working
+
+Retire a host.
+
+.. code:: shell
+
+  $ mkr.py retire --host-id foo
+
+Get status of a host.
+
+.. code:: shell
+
+  $ mkr.py status --host-id foo
+
+Authentication
+--------------
+
+.. code:: shell
+
+  $ export MACKEREL_APIKEY=foobar
+