Commit 4e924b31 authored by kaniini's avatar kaniini

fill in the details with the README

parent 52b8db1c
Pipeline #19619 passed with stage
in 50 seconds
# FastSanitize
**TODO: Add description**
A high performance HTML sanitization library built on [FastHTML][fh], our
rewrite of Myhtmlex. It was created to improve HTML sanitization performance
in [Pleroma][pl], a high-performance, versatile federated social networking
platform.
[fh]: https://git.pleroma.social/pleroma/myhtmlex
[pl]: https://pleroma.social
## Features
* Meta-programming: build your own scrubbing policies with macros, mostly
compatible with HtmlSanitizeEx.
* Performance: on average, 2-3 times faster than HtmlSanitizeEx with typical
documents with considerably less memory usage.
* Uses the MyHTML parsing engine which parses HTML in the same way browsers
do.
* Uses an efficient AST for scrubbing HTML nodes and Erlang iolists for
efficient HTML generation.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `fast_sanitize` to your list of dependencies in `mix.exs`:
The package can be installed by adding `fast_sanitize` to your list of
dependencies in `mix.exs`:
```elixir
def deps do
......@@ -15,7 +32,4 @@ def deps do
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/fast_sanitize](https://hexdocs.pm/fast_sanitize).
Docs can be found at [https://hexdocs.pm/fast_sanitize](https://hexdocs.pm/fast_sanitize).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment