From 883f6388573c365090f1e5df184d106f45a58475 Mon Sep 17 00:00:00 2001
From: Matthias <matthias-endler@gmx.net>
Date: Wed, 25 Nov 2020 10:22:03 +0100
Subject: [PATCH] Revamp documentation

---
 README.md | 36 +++++++++++++++---------------------
 1 file changed, 15 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 5b7ca8b..b9bf50f 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ![Rust](https://github.com/hello-rust/lychee/workflows/Rust/badge.svg)
 
-A fast, async, resource-friendly link checker written in Rust.
+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.
 
@@ -72,43 +72,37 @@ This comparison is made on a best-effort basis. Please create a PR to fix outdat
 - Skip duplicate URLs
 - Request throttling
 
-## Users
-
-- https://github.com/analysis-tools-dev/static-analysis (soon)
-- https://github.com/mre/idiomatic-rust (soon)
-
-## How?
+## Installation
 
 ```
 cargo install lychee
 ```
 
-Optional (to avoid being rate limited for GitHub links): set an environment variable with your token
-like so `GITHUB_TOKEN=xxxx`, or use the `--github-token` CLI option. This can also be set in the
-config file.
+## Usage
 
-Run it inside a repository with a `README.md` or specify a file with
+Run it inside a repository with a `README.md`, or specify a file with
 
 ```
 lychee <yourfile>
 ```
 
+Optional (to avoid getting rate-limited): set an environment variable with your Github token
+like so `GITHUB_TOKEN=xxxx`, or use the `--github-token` CLI option. It can also be set in the
+config file.
+
 ### CLI exit codes
 
 - `0` for success (all links checked successfully or excluded/skipped as configured)
 - `1` for any unexpected runtime failures or config errors
 - `2` for link check failures (if any non-excluded link failed the check)
 
-## Comparison
+## Users
 
-Collecting more link checkers here for comparison:
-
-- https://github.com/bartdag/pylinkvalidator
-- https://github.com/victoriadrake/hydra-link-checker
-
-## Thanks
-
-...to my Github sponsors and Patreon sponsors for supporting these projects. If
-you want to help out as well, [go here](https://github.com/sponsors/mre/).
+- https://github.com/analysis-tools-dev/static-analysis (soon)
+- https://github.com/mre/idiomatic-rust (soon)
 
+## Credits
 
+The first prototype of lychee was built in [episode 10 of Hello Rust](https://hello-rust.show/10/).
+Thanks to all Github- and Patreon sponsors for supporting the development since the beginning.
+Also, thanks to all the great contributors who have since made this project more mature.