|
3 | 3 | [](https://travis-ci.org/mischov/meeseeks_html5ever) |
4 | 4 | [](https://hex.pm/packages/meeseeks_html5ever) |
5 | 5 |
|
6 | | -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). |
| 6 | +Originally 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), Meeseeks_Html5ever has grown to include additional functionality, such as use of xml5ever for XML parsing. |
7 | 7 |
|
8 | 8 | ## Dependencies |
9 | 9 |
|
10 | 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 | 11 |
|
| 12 | +## Compatibility |
| 13 | + |
| 14 | +Meeseeks_Html5ever is tested with a minimum combination of Elixir 1.4.0 and Erlang/OTP 19.3, and a maximum combination of Elixir 1.8.1 and Erlang/OTP 21.0 |
| 15 | + |
12 | 16 | ## Installation |
13 | 17 |
|
14 | 18 | Ensure Rust is installed, then add Meeseeks_Html5ever to your `mix.exs`: |
|
23 | 27 |
|
24 | 28 | Finally, run `mix deps.get`. |
25 | 29 |
|
| 30 | +## Contribute |
| 31 | + |
| 32 | +Contributions are very welcome, especially bug reports. |
| 33 | + |
| 34 | +If submitting a bug report, please search open and closed issues first. |
| 35 | + |
| 36 | +To make a pull request, fork the project, create a topic branch off of `master`, push your topic branch to your fork, and open a pull request. |
| 37 | + |
| 38 | +If you're submitting a bug fix, please include a test or tests that would have caught the problem. |
| 39 | + |
| 40 | +If you're submitting new features, please test and document as appropriate. |
| 41 | + |
| 42 | +Before submitting a PR, please run `mix format`. |
| 43 | + |
| 44 | +By submitting a patch, you agree to license your work under the license of this project. |
| 45 | + |
| 46 | +### Running Tests |
| 47 | + |
| 48 | +``` |
| 49 | +$ git clone https://github.com/mischov/meeseeks.git |
| 50 | +$ cd meeseeks_html5ever |
| 51 | +$ mix deps.get |
| 52 | +$ mix test |
| 53 | +``` |
| 54 | + |
| 55 | +### Building Docs |
| 56 | + |
| 57 | +``` |
| 58 | +$ MIX_ENV=docs mix docs |
| 59 | +``` |
| 60 | + |
26 | 61 | ## License |
27 | 62 |
|
28 | 63 | Licensed under either of |
|
0 commit comments