From 80dcedfe8770c3b83cfa8e9debfb882db09d49d5 Mon Sep 17 00:00:00 2001
From: oreh <herolxh@gmail.com>
Date: Mon, 16 Feb 2015 18:00:20 +0000
Subject: [PATCH] add readme

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/README.md b/README.md
index e69de29..2197042 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,50 @@
+# introduction
+
+_simpletcd_ is a simple etcd client that aims to make recursive get/put operations easier.
+
+
+# Install
+
+```
+pip install simpletcd
+```
+
+# Usage
+
+## Put a value to a key
+```python
+from simpletcd.ectd import Etcd
+
+etcd = Etcd()
+etcd.put('mytestkey', 'test value')
+
+```
+
+## Put multiple keys recursively
+
+```python
+from simpletcd.ectd import Etcd
+
+etcd = Etcd()
+etcd.put('mytopkey', {'key_0': 'v0', 'key_1': {'key_1_0': 'v1_0', 'key_1_1': 'v1_1'}})
+
+```
+
+## Get a key
+```python
+from simpletcd.ectd import Etcd
+
+etcd = Etcd()
+etcd.get('mytestkey')
+
+```
+
+## Get multiple keys recursively
+```python
+from simpletcd.ectd import Etcd
+
+etcd = Etcd()
+etcd.put('mytopkey')
+
+```
+