Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-05-14 00:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use lychee namespace in lib examples and link to docs

Browse source
This commit is contained in:
Matthias 2021-01-08 10:52:10 +01:00 committed by GitHub
parent 2d6b5c831f
commit d93662dc22
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,6 +1,7 @@
![lychee](assets/banner.png)
![Rust](https://github.com/hello-rust/lychee/workflows/Rust/badge.svg)
[![docs.rs](https://docs.rs/lychee/badge.svg)](https://docs.rs/lychee)
A fast, async, resource-friendly link checker written in Rust. \
For GitHub links, it can optionally use a `GITHUB_TOKEN` to avoid getting blocked by the rate
@ -203,10 +204,9 @@ You can use lychee as a library for your own projects.
Simply add it as a dependency and build your client:
```rust
use lychee::ClientBuilder;
use http::StatusCode
let client = ClientBuilder::default().build()?;
let client = lychee::ClientBuilder::default().build()?;
let url = Url::parse("https://github.com/lycheeverse/lychee")?;
let response = client.check(Website(url)).await?;
assert!(matches!(response.status, Status::Ok(_)));
@ -215,7 +215,7 @@ assert!(matches!(response.status, Status::Ok(_)));
The client is very customizable, e.g.
```rust
let client = ClientBuilder::default()
let client = lychee::ClientBuilder::default()
.includes(includes)
.excludes(excludes)
.max_redirects(cfg.max_redirects)
@ -231,6 +231,8 @@ let client = ClientBuilder::default()
.build()?;
```
See the [builder documentation](https://docs.rs/lychee/latest/lychee/struct.ClientBuilder.html) for all options.
## Troubleshooting and workarounds
We collect a list of common workarounds for various websites in our [troubleshooting guide](./TROUBLESHOOTING.md).