commit 05b792ccb62dd28f323da2254166213767ee86c2
author Armin Ronacher <armin.ronacher@active-4.com> Tue Jun 22 19:48:44 2010 +0200
committer Armin Ronacher <armin.ronacher@active-4.com> Tue Jun 22 19:48:44 2010 +0200
tree e3a3e8ed7ebae6aab41092d18e4189b4a8c35f5c
parent 20706f20512c143c3bcb1fbdcd729e57f4a3a82f

Updated 'documentation'

README.rst

diff --git a/README.rst b/README.rst
index e6c9de0..e6e9823 100644
--- a/README.rst
+++ b/README.rst
@@ -9,3 +9,25 @@
 >>> tmpl = Markup("<em>%s</em>")
 >>> tmpl % "Peter > Lustig"
 Markup(u'<em>Peter &gt; Lustig</em>')
+
+If you want to make an object unicode that is not yet unicode
+but don't want to lose the taint information, you can use the
+`soft_unicode` function:
+
+>>> from markupsafe import soft_unicode
+>>> soft_unicode(42)
+u'42'
+>>> soft_unicode(Markup('foo'))
+Markup(u'foo')
+
+Objects can customize their HTML markup equivalent by overriding
+the `__html__` function:
+
+>>> class Foo(object):
+...  def __html__(self):
+...   return '<strong>Nice</strong>'
+...
+>>> escape(Foo())
+Markup(u'<strong>Nice</strong>')
+>>> Markup(Foo())
+Markup(u'<strong>Nice</strong>')