README.md

# AflFantasyScraper

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `afl_fantasy_scraper` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:afl_fantasy_scraper, "~> 0.1.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/afl_fantasy_scraper>.

## Running the Crawler

1. Load module into iex
```bash
>% iex.bat -S mix # for windows
>% iex -S mix
```

2. Run scraper
```elixir
Crawly.Engine.start_spider(AflFantasyScraper.BasicSpider)
```