Updates readme. Uploaded to pypi.

dsc · Jan 26, 2010 · 29f50e9 · 29f50e9
1 parent eafff15
commit 29f50e9
Showing 1 changed file with 28 additions and 27 deletions.
diff --git a/README.txt b/README.txt
@@ -3,56 +3,57 @@ bunch
 
 Bunch is a dictionary that supports attribute-style access, a la JavaScript.
 
-    >>> b = Bunch()
-    >>> b.hello = 'world'
-    >>> b.hello
-    'world'
-    >>> b['hello'] += "!"
-    >>> b.hello
-    'world!'
-    >>> b.foo = Bunch(lol=True)
-    >>> b.foo.lol
-    True
-    >>> b.foo is b['foo']
-    True
+>>> b = Bunch()
+>>> b.hello = 'world'
+>>> b.hello
+'world'
+>>> b['hello'] += "!"
+>>> b.hello
+'world!'
+>>> b.foo = Bunch(lol=True)
+>>> b.foo.lol
+True
+>>> b.foo is b['foo']
+True
 
 
 Dictionary Methods
 ------------------
 
 A Bunch is a subclass of ``dict``; it supports all the methods a ``dict`` does:
 
-    >>> b.keys()
-    ['foo', 'hello']
+>>> b.keys()
+['foo', 'hello']
 
 Including ``update()``:
 
-    >>> b.update({ 'ponies': 'are pretty!' }, hello=42)
-    >>> print repr(b)
-    Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')
+>>> b.update({ 'ponies': 'are pretty!' }, hello=42)
+>>> print repr(b)
+Bunch(foo=Bunch(lol=True), hello=42, ponies='are pretty!')
 
 As well as iteration:
 
-    >>> [ (k,b[k]) for k in b ]
-    [('ponies', 'are pretty!'), ('foo', Bunch(lol=True)), ('hello', 42)]
+>>> [ (k,b[k]) for k in b ]
+[('ponies', 'are pretty!'), ('foo', Bunch(lol=True)), ('hello', 42)]
 
 And "splats":
 
-    >>> "The {knights} who say {ni}!".format(**Bunch(knights='lolcats', ni='can haz'))
-    'The lolcats who say can haz!'
+>>> "The {knights} who say {ni}!".format(**Bunch(knights='lolcats', ni='can haz'))
+'The lolcats who say can haz!'
 
 
 Miscellaneous
 -------------
 
- * Bunch converts easily to (``unbunchify``, ``Bunch.toDict``) and from (``bunchify``, ``Bunch.fromDict``) a normal ``dict``, making it easy to cleanly serialize them to JSON or YAML.
- 
- * It is safe to ``import *`` from this module. You'll get: ``Bunch``, ``bunchify``, and ``unbunchify``.
- 
- * Tests::
- 
+* Bunch converts easily to (``unbunchify``, ``Bunch.toDict``) and from (``bunchify``, ``Bunch.fromDict``) a normal ``dict``, making it easy to cleanly serialize them to JSON or YAML.
+
+* It is safe to ``import *`` from this module. You'll get: ``Bunch``, ``bunchify``, and ``unbunchify``.
+
+* Tests::
+
     $ python -m bunch.test -v
 
+
 Feedback
 --------