aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 5e52cae..2dc7420 100644
--- a/README.rst
+++ b/README.rst
@@ -2,6 +2,12 @@
Bleach
======
+.. image:: https://travis-ci.org/jsocol/bleach.png?branch=master
+ :target: https://travis-ci.org/jsocol/bleach
+
+.. image:: https://badge.fury.io/py/Bleach.svg
+ :target: http://badge.fury.io/py/Bleach
+
Bleach is an HTML sanitizing library that escapes or strips markup and
attributes based on a white list. Bleach can also linkify text safely, applying
filters that Django's ``urlize`` filter cannot, and optionally setting ``rel``
@@ -20,10 +26,21 @@ The version on GitHub_ is the most up-to-date and contains the latest bug
fixes. You can find full documentation on `ReadTheDocs`_.
+Reporting Security Issues
+=========================
+
+If you believe you have found an exploit in a patched version of Bleach,
+master or the latest released version on PyPI, **please do not post it
+in a GitHub issue**. Please contact me privately, at
+`me+bleach@jamessocol.com <mailto:me+bleach@jamessocol.com>`.
+
+
Basic Use
=========
-The simplest way to use Bleach is::
+The simplest way to use Bleach is:
+
+.. code-block:: python
>>> import bleach