From 9cc96d8b812bbacf331f7620fb0c11cd18eef0b0 Mon Sep 17 00:00:00 2001 From: Russell Ballestrini Date: Fri, 6 Nov 2015 23:40:06 -0500 Subject: [PATCH] updated readme --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index ecf8e63..fbdb199 100644 --- a/README.rst +++ b/README.rst @@ -5,18 +5,39 @@ A small library for python which enables key lookups on deeply nested documents. Documents may be built out of dictionaries (dicts) and/or lists. +.. contents:: + :author: Russell Ballestrini +:web: http://russell.ballestrini.net + :license: Public Domain + quick start =========== install ------- +install from pypi using pip:: + + pip install nested-lookup + +or easy_install:: + + easy_install nested-lookup + +or install from source using:: + + git clone https://github.com/russellballestrini/nested-lookup.git + cd nested-lookup + pip install . + tutorial -------- + +