diff --git a/README.md b/README.md index 7a234a3..6ddddff 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # Scrape [![Hex.pm](https://img.shields.io/hexpm/dt/scrape.svg)](https://hex.pm/packages/scrape) @@ -6,17 +7,22 @@ ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `scrape` to your list of dependencies in `mix.exs`: +The package can be installed by adding `scrape` to your list of dependencies in `mix.exs`: ```elixir def deps do [ - {:scrape, "~> 0.1.0"} + {:scrape, "~> 3.0.0"} ] end ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at [https://hexdocs.pm/scrape](https://hexdocs.pm/scrape). +## Usage + +* `Scrape.domain!(url)` -> get structured data of a domain-type url (like https://bbc.com) +* `Scrape.feed!(url)` -> get structured data of a RSS/Atom feed +* `Scrape.article!(url)` -> get structured data of an article-type url + +## License + +LGPLv3. You can use this package any way you want (including commercially), but I want bugfixes and improvements to flow back into this package.