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

Update README.md

Browse source
This commit is contained in:
Matthias 2020-11-06 00:22:14 +01:00 committed by GitHub
parent 326683f4eb
commit f7a1fcdf70
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,23 +2,12 @@
![Rust](https://github.com/hello-rust/lychee/workflows/Rust/badge.svg)
...because who says I can't write yet another link checker?
## What?
This thing was created from [Hello Rust Episode
10](https://hello-rust.show/10/). It's a link checker.
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
limiter.
![Lychee demo](./assets/lychee.gif)
## Why?
The existing link checkers were not flexible enough for my use-case. lychee
runs all requests fully asynchronously and has a low memory/CPU footprint.
## Features
This comparison is made on a best-effort basis. Please create a PR to fix outdated information.
@ -59,7 +48,7 @@ This comparison is made on a best-effort basis. Please create a PR to fix outdat
| Amazing lychee logo | ✔️ | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ |
| Config file | ✔️ | ✖️ | ✖️ | ✖️ | ✔️ | ✔️ | ✔️ | ✖️ |
## Planned features:
## Planned features. Please help out!
- report output in HTML, SQL, CSV, XML, JSON, YAML... format
- report extended statistics: request latency