From 34bbbed95b9f55d2fd41bc0f08477c95ca9c29fd Mon Sep 17 00:00:00 2001 From: hellerve Date: Tue, 17 Jan 2017 14:52:49 +0100 Subject: [PATCH] added intro to readme --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 3edcbbe..c5fa029 100644 --- a/README.rst +++ b/README.rst @@ -9,3 +9,10 @@ Installation :: pip install manipulator + +Usage +----- + +`manipulator` mainly exposes three functions, `get`, `update`, and `set`. +`get` retrieves data, `update` transforms it based on its form, and `set` +transforms it by simply resetting.