Added more info in README
[htmlpurifier/darkodev.git] / README.md
blob029369f6f359ba26dd4df9a3758679826a6455bf
1 HTML Purifier
2 =============
4 HTML Purifier is an HTML filtering solution that uses a unique combination
5 of robust whitelists and agressive parsing to ensure that not only are
6 XSS attacks thwarted, but the resulting HTML is standards compliant.
8 HTML Purifier is oriented towards richly formatted documents from
9 untrusted sources that require CSS and a full tag-set.  This library can
10 be configured to accept a more restrictive set of tags, but it won't be
11 as efficient as more bare-bones parsers. It will, however, do the job
12 right, which may be more important.
14 Places to go:
16 * See INSTALL for a quick installation guide
17 * See docs/ for developer-oriented documentation, code examples and
18   an in-depth installation guide.
19 * See WYSIWYG for information on editors like TinyMCE and FCKeditor
21 HTML Purifier can be found on the web at: [http://htmlpurifier.org/](http://htmlpurifier.org/)
23 ## Installation
25 Package available on [Composer](https://packagist.org/packages/ezyang/htmlpurifier).
27 If you're using Composer to manage dependencies, you can use
29     $ composer require "ezyang/htmlpurifier": "dev-master"