Skip to content

Commit

Permalink
Added docs link
Browse files Browse the repository at this point in the history
  • Loading branch information
marksweb committed Sep 22, 2021
1 parent bf7e2b5 commit 676badf
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
django-bleach - Bleach and sanitise user HTML
=============================================

.. image:: https://travis-ci.org/marksweb/django-bleach.svg?branch=master
:target: https://travis-ci.org/marksweb/django-bleach
.. image:: https://readthedocs.org/projects/django-bleach/badge/?version=latest
:target: https://django-bleach.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: http://img.shields.io/pypi/v/django-bleach.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-bleach/
:alt: Latest Version

.. image:: http://img.shields.io/pypi/l/django-bleach.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-bleach/
:alt: License

|
.. image:: https://codecov.io/gh/marksweb/django-bleach/branch/master/graph/badge.svg
:target: https://codecov.io/gh/marksweb/django-bleach

Expand All @@ -19,15 +26,15 @@ django-bleach - Bleach and sanitise user HTML
:target: https://pypi.python.org/pypi/django-bleach/
:alt: Downloads

.. image:: http://img.shields.io/pypi/l/django-bleach.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-bleach/
:alt: License
|
Bleach_ is a Python module that takes any HTML input, and returns
valid, sanitised HTML that contains only an allowed subset of HTML tags,
attributes and styles. ``django-bleach`` is a Django app that makes using
``bleach`` extremely easy.

`Read the documentation here`_.

Setup
-----

Expand Down Expand Up @@ -152,6 +159,7 @@ addresses in text that may be an HTML fragment to links, while preserving:


.. _bleach: https://github.com/mozilla/bleach
.. _Read the documentation here: https://django-bleach.readthedocs.io/
.. _bleach documentation: https://bleach.readthedocs.io/en/latest/clean.html
.. _django-ckeditor: https://github.com/shaunsephton/django-ckeditor
.. _linkify: https://bleach.readthedocs.io/en/latest/linkify.html?highlight=linkify#bleach.linkify "linkify"

0 comments on commit 676badf

Please sign in to comment.