Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Anonyfox committed May 31, 2019
1 parent 077bffc commit accfe14
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# Scrape

[![Hex.pm](https://img.shields.io/hexpm/dt/scrape.svg)](https://hex.pm/packages/scrape)
Expand All @@ -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.

0 comments on commit accfe14

Please sign in to comment.