summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTimothy Crosley <timothy.crosley@gmail.com>2013-09-01 16:23:33 -0400
committerTimothy Crosley <timothy.crosley@gmail.com>2013-09-01 16:23:33 -0400
commit3fea56e5961850c2763759d5ec97ff8fe3f40f08 (patch)
treed3cdcdd176316e7b64372e836aaeed506b383af4
parentc042302545b5fad622c1c29804305b3c9b6364e6 (diff)
downloadpies-3fea56e5961850c2763759d5ec97ff8fe3f40f08.tar.gz
Update readme with full use instruction
-rw-r--r--README.md48
1 files changed, 45 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6f40512..de0e31d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,46 @@
-pies
-====
+pies!
+====================
+
+The simplest (and tastiest) way to write one program that runs on both Python 2.6+ and Python 3.
+
+
+let's eat some pies!
+======================
+
+Installing pies
+
+ pip install pies
+
+or if you prefer:
+
+ easy_install pies
+
+
+integrating pies into your diet
+======================
+
+Using and integrating pies into an existing Python 2.6 code base (to achieve Python 3 dual support) couldn't be simpler:
+
+ from pies import *
+
+You will then simply have to make some simple changes to your Python code:
+
+- u'string' -> u('string')
+- my_iterable.iteritems -> iteritems(my_iterable)
+- my_iterable.itervalues -> itervalues(my_iterable)
+- my_iterable.iterkeys -> iterkeys(my_iterable)
+
+The following will work unchanged in Python 3 after import (using the Python 2 syntax):
+
+- xrange
+- long
+- unicode
+- urllib.quote
+- urllib.quote_plus
+- urllib.unquote
+- urllib.unquote_plus
+- urllib.urlencode
+
+pies will also automatically install and include the most optimal version of OrderedDict for the python environment
+in use, so you should remove any other explicit imports of OrderedDict.
-The simplest way to write one program that runs on both Python 2 and Python 3.