Skip to content

Commit 19be79f

Browse files
committed
Improve docs with references
1 parent 26ea944 commit 19be79f

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

lib/html5ever.ex

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
defmodule Html5ever do
22
@moduledoc """
3-
The html5ever is an HTML parser written in Rust.
3+
This is an HTML parser written in Rust.
4+
5+
The project provides a NIF - Native Implemented Function.
6+
It works on top of a parser of the same name from the Servo
7+
project. See: [https://github.com/servo/html5ever](https://github.com/servo/html5ever).
48
59
By default this lib will try to use a precompiled NIF
610
from the GitHub releases page. This way you don't need
711
to have the Rust toolchain installed.
8-
In case no precompiled file is found an error is raised.
12+
In case no precompiled file is found and the Mix env is
13+
production then an error is raised.
914
1015
You can force the precompilation to occur by setting the
1116
value of the `HTML5EVER_BUILD` environment variable to
12-
"true" or "1".
17+
"true" or "1". Alternatively you can also set the application
18+
env `:build_from_source` to `true` in order to force the build:
19+
20+
config :html5ever, Html5ever, build_from_source: true
21+
22+
This project is possible thanks to [Rustler](https://hexdocs.pm/rustler).
1323
"""
1424

1525
@doc """

0 commit comments

Comments
 (0)