Release v0.10.0

CHANGELOG.md

@@ -6,11 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.10.0] - 2021-11-24
+
+### Added
+
+- Add the ability to download precompiled NIFs. We provide compiled
+NIF files in our GitHub releases page (from GitHub Actions) and the
+lib will try to download the correct NIF respecting the OS, NIF version
+and architecture of your build machine. This also works for Nerves
+projects that compiles to different targets. This way the Rust toolchain
+is not needed for most of people using this project.
+
+### Fixed
+
+- Fix compilation on macOS.
+
 ## [0.9.0] - 2021-10-02
 
 ### Added
 
 - Add support for OTP 24. This was achieved by updating Rustler to v0.22.
 
-[Unreleased]: https://github.com/rusterlium/html5ever_elixir/compare/v0.9.0...HEAD
+[Unreleased]: https://github.com/rusterlium/html5ever_elixir/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/rusterlium/html5ever_elixir/releases/tag/v0.10.0
 [0.9.0]: https://github.com/rusterlium/html5ever_elixir/releases/tag/v0.9.0

README.md

@@ -12,7 +12,7 @@ The package can be installed by adding `html5ever` to your list of dependencies
 
 ```elixir
 def deps do
-  [{:html5ever, "~> 0.9.0"}]
+  [{:html5ever, "~> 0.10.0"}]
 end
 ```
 

lib/html5ever.ex

@@ -3,16 +3,16 @@ defmodule Html5ever do
   This is an HTML parser written in Rust.
 
   The project provides a NIF - Native Implemented Function.
-  It works on top of a parser of the same name from the Servo
-  project. See: [https://github.com/servo/html5ever](https://github.com/servo/html5ever).
+  It works on top of [a parser of the same name](https://github.com/servo/html5ever)
+  from the Servo project.
 
   By default this lib will try to use a precompiled NIF
   from the GitHub releases page. This way you don't need
   to have the Rust toolchain installed.
   In case no precompiled file is found and the Mix env is
   production then an error is raised.
 
-  You can force the precompilation to occur by setting the
+  You can force the compilation to occur by setting the
   value of the `HTML5EVER_BUILD` environment variable to
   "true" or "1". Alternatively you can also set the application
   env `:build_from_source` to `true` in order to force the build:

mix.exs

@@ -1,7 +1,7 @@
 defmodule Html5ever.Mixfile do
   use Mix.Project
 
-  @version "0.9.0"
+  @version "0.10.0"
   @repo_url "https://github.com/rusterlium/html5ever_elixir"
 
   def project do
@@ -34,14 +34,24 @@ defmodule Html5ever.Mixfile do
   defp docs do
     [
       main: "Html5ever",
+      extras: ["CHANGELOG.md"],
+      skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
       source_ref: "v#{@version}",
       source_url: @repo_url
     ]
   end
 
   defp package do
     [
-      files: ["lib", "native", "mix.exs", "README.md", "LICENSE-APACHE", "LICENSE-MIT"],
+      files: [
+        "lib",
+        "native",
+        "mix.exs",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE-APACHE",
+        "LICENSE-MIT"
+      ],
       maintainers: ["hansihe", "philip"],
       licenses: ["MIT", "Apache-2.0"],
       links: %{"GitHub" => @repo_url}