aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2010-06-22 19:46:25 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2010-06-22 19:46:25 +0200
commit20706f20512c143c3bcb1fbdcd729e57f4a3a82f (patch)
tree8d59f77ff924b5c0e645ca13f895735db62fcd22 /README.rst
parentea75ec929f07b320ebbed5ddd0605cd9b5122097 (diff)
downloadmarkupsafe-20706f20512c143c3bcb1fbdcd729e57f4a3a82f.tar.gz
Renamed readme
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e6c9de0
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,11 @@
+MarkupSafe
+==========
+
+Implements a unicode subclass that supports HTML strings:
+
+>>> from markupsafe import Markup, escape
+>>> escape("<script>alert(document.cookie);</script>")
+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>')