Page MenuHomePhorge
Files F115365

No OneTemporary
Actions

Size
1 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/README.md b/README.md
index a1a37cb..4763253 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,35 @@
# 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
[
{:fast_sanitize, "~> 0.1.0"}
]
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).

File Metadata

Mime Type
text/x-diff
Expires
Thu, Nov 28, 12:37 AM (1 d, 20 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
40778
Default Alt Text
(1 KB)

Event Timeline