From 05b792ccb62dd28f323da2254166213767ee86c2 Mon Sep 17 00:00:00 2001
From: Armin Ronacher <armin.ronacher@active-4.com>
Date: Tue, 22 Jun 2010 19:48:44 +0200
Subject: Updated 'documentation'

---
 README.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.rst b/README.rst
index e6c9de0..e6e9823 100644
--- a/README.rst
+++ b/README.rst
@@ -9,3 +9,25 @@ Markup(u'&lt;script&gt;alert(document.cookie);&lt;/script&gt;')
 >>> 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>')
-- 
cgit v1.2.1