Nekomata/site_icons
Nekomata/site_icons
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Sam Denty 2023-01-03 17:49:19 +00:00
parent 569a3cc31f
commit a6cb321822
No known key found for this signature in database
GPG key ID: 7B4EAF7B9E291B79
1 changed files with 11 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -18,15 +18,19 @@ An efficient website icon scraper for rust or command line usage.
First run `cargo install site_icons`, then:
```bash
site-icons https://github.com
# https://github.githubassets.com/favicons/favicon.svg site_favicon svg
# https://github.githubassets.com/app-icon-512.png app_icon png 512x512
# https://github.githubassets.com/apple-touch-icon-180x180.png app_icon png 180x180
<details open>
<summary><code>site-icons https://github.com</code></summary>
```
https://github.githubassets.com/favicons/favicon.svg site_favicon svg
https://github.githubassets.com/app-icon-512.png app_icon png 512x512
https://github.githubassets.com/apple-touch-icon-180x180.png app_icon png 180x180
```
<details>
<summary>View JSON output<pre>site-icons https://reactjs.org --json</pre></summary>
</details>
<details open>
<summary><code>site-icons https://reactjs.org --json</code></summary>
```json
[
@ -63,21 +67,6 @@ site-icons https://github.com
</details>
### Rust usage
```rust
use site_icons::SiteIcons;
let mut icons = SiteIcons::new();
// scrape the icons from a url
let entries = icons.load_website("https://github.com", false).await?;
// entries are sorted from highest to lowest resolution
for icon in entries {
println!("{:?}", icon)
}
```
### Sources
- HTML favicon tag (or looking for default `/favicon.svg` / `/favicon.ico`)