Skip to content

Commit 6419d90

Browse files
committed
Update documentation
1 parent efe203f commit 6419d90

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
[![Build Status](https://travis-ci.org/mischov/meeseeks_html5ever.svg?branch=master)](https://travis-ci.org/mischov/meeseeks_html5ever)
44
[![MeeseeksHtml5ever version](https://img.shields.io/hexpm/v/meeseeks_html5ever.svg)](https://hex.pm/packages/meeseeks_html5ever)
55

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.
77

88
## Dependencies
99

1010
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).
1111

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+
1216
## Installation
1317

1418
Ensure Rust is installed, then add Meeseeks_Html5ever to your `mix.exs`:
@@ -23,6 +27,37 @@ end
2327

2428
Finally, run `mix deps.get`.
2529

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+
2661
## License
2762

2863
Licensed under either of

lib/meeseeks_html5ever.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ defmodule MeeseeksHtml5ever do
66
"""
77

88
@doc """
9-
Parses an HTML string into a `Meseeks.Document`.
9+
Parses an HTML string into a `Meeseeks.Document`.
1010
"""
1111
def parse_html(html) do
1212
MeeseeksHtml5ever.Native.parse_html(html)
@@ -21,7 +21,7 @@ defmodule MeeseeksHtml5ever do
2121
end
2222

2323
@doc """
24-
Parses an XML string into a `Meseeks.Document`.
24+
Parses an XML string into a `Meeseeks.Document`.
2525
"""
2626
def parse_xml(xml) do
2727
MeeseeksHtml5ever.Native.parse_xml(xml)

0 commit comments

Comments
 (0)