Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-04-07 06:51:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
Matthias Endler 2020-08-13 15:41:27 +02:00
parent 22044275f7
commit f8b344fe5a
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -15,7 +15,7 @@ specially by using a `GITHUB_TOKEN` to avoid getting blocked less by the rate li
The existing link checkers were not flexible enough for my use-case.
lychee can...
- run fully asynchronously
- run requests concurrently (fully async Rust)
- handle links inside Markdown, HTML, and other documents
- handle chunked encodings
- handle gzip compression
@ -25,7 +25,17 @@ lychee can...
- handle a configurable number of redirects
- disguise as a different user agent (like curl)
- optionally ignore SSL certificate errors
- SOON: automatically retry and backoff
- run with a low memory/CPU footprint
SOON:
- automatically retry and backoff
- check relative and absolute paths
- limit schema
- check multiple files
- support input files using wildcards
- set timeout for HTTP requests in seconds. Disabled by default.
- accept custom headers (see https://github.com/rust-lang/crates.io/issues/788)
## How?