summaryrefslogtreecommitdiff
path: root/python/bleach/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/bleach/README')
-rw-r--r--python/bleach/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/python/bleach/README b/python/bleach/README
new file mode 100644
index 0000000000..2b3732bd9e
--- /dev/null
+++ b/python/bleach/README
@@ -0,0 +1,11 @@
+Bleach is a whitelist-based HTML sanitizing library that escapes or strips
+markup and attributes.
+
+Bleach can also linkify text safely, applying filters that Django's urlize
+filter cannot, and optionally setting rel attributes, even on links already in
+the text.
+
+Bleach is intended for sanitizing text from untrusted sources. If you find
+yourself jumping through hoops to allow your site administrators to do lots of
+things, you're probably outside the use cases. Either trust those users, or
+don't.