During the last year, # ... -# ... -# or check out our sidebar for other learning resources.
diff --git a/CANGELOG.md b/CANGELOG.md new file mode 100644 index 0000000..01d1c0e --- /dev/null +++ b/CANGELOG.md @@ -0,0 +1,5 @@ +# Change log + +## [0.3.0] - 2016.04.24 + +- Release!! diff --git a/README.md b/README.md index b97b6be..087b404 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/keepcosmos/readability.svg?branch=master)](https://travis-ci.org/keepcosmos/readability) [![Readability version](https://img.shields.io/hexpm/v/readability.svg)](https://hex.pm/packages/readability) -Readability library for extracting and curating articles. +Readability is Elixir library for extracting and curating articles. Check out The [Documentation](https://hexdocs.pm/readability/Readability.html) for full and detailed guides ## Installation @@ -29,7 +29,7 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed ## Usage To parse document, you must prepare html string. -The below example below, `html` variable is the html code of page from [Elixir Design Goals](http://elixir-lang.org/blog/2013/08/08/elixir-design-goals/) +The example below, `html` variable is the html source from [Elixir Design Goals](http://elixir-lang.org/blog/2013/08/08/elixir-design-goals/) ### Examples ```elixir @@ -39,33 +39,35 @@ Readability.title(html) #=> Elixir Design Goals ### Extract the content with transformed html. -content = Readability.content(html) -Readability.raw_html(content) +html +|> Readability.article +|> Readability.raw_html #=> #
During the last year, # ... -# ... -# or check out our sidebar for other learning resources.