diff --git a/README.md b/README.md index f2238c1..6fb3f8c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # favicon-scraper -Scrapes favicons from websites. +Scrapes favicons from websites. Does not particularly care for 100% optimal +performance, it just needs to work. -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 = 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); +``` diff --git a/src/lib.rs b/src/lib.rs index c82456d..00471b6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -92,4 +92,14 @@ mod tests { println!("Kind of icon: {:?}\n", icon.kind); } } + + #[tokio::test] + async fn test_readme_example() { + use crate::{scrape, Icon}; + + let icons: Vec = 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); + } }