favicon-scraper/README.md

# favicon-scraper

Scrapes favicons from websites. Does not particularly care for 100% optimal
performance, it just needs to work.

To get started, try the `scrape` function:

```rust
use favicon_scraper::{scrape, Icon};

let icons: Vec<Icon> = scrape("https://google.com").await.unwrap();

// Should find something like "https://www.google.com/favicon.ico"
println!("Google's icon can be found at {}", icons[0].url);
```