Skip to content

Commit 937c864

Browse files
committed
Update README to emphasize Rust dependency
1 parent d83606b commit 937c864

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,24 @@
55

66
A fork of Hansihe's [html5ever_elixir](https://github.com/hansihe/html5ever_elixir) that is more tightly coupled with [Meeseeks](https://github.com/mischov/meeseeks).
77

8+
## Dependencies
9+
10+
Meeseeks_Html5ever depends on the Rust library [html5ever](https://github.com/servo/html5ever), and you will need to have the Rust compiler [installed](https://www.rust-lang.org/en-US/install.html).
11+
812
## Installation
913

10-
The package can be installed by adding `meeseeks_html5ever` to your list of dependencies in `mix.exs`:
14+
Ensure Rust is installed, then add Meeseeks_Html5ever to your `mix.exs`:
1115

1216
```elixir
1317
def deps do
14-
[{:meeseeks_html5ever, "~> 0.6.1"}]
18+
[
19+
{:meeseeks_html5ever, "~> 0.6.1"}
20+
]
1521
end
1622
```
1723

24+
Finally, run `mix deps.get`.
25+
1826
## License
1927

2028
Licensed under either of

0 commit comments

Comments
 (0)