Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manish0kuniyal authored Jul 14, 2023
1 parent 3467566 commit 59847a3
Showing 1 changed file with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,10 @@
Finds broken hyperlinks and mail addresses inside Markdown, HTML,
reStructuredText, or any other text file or website!

<br><hr>
[🔧 Installation](#installation)
<br>
[🎯 Features](#features)
<br>
[💻 Usage](#cliusage)
<br>
[📚 Library usage](#lib-usage)
<br>
[👥 Users](#users)
<br>
<br>
Available as a command-line utility, a library and a [GitHub Action](https://github.com/lycheeverse/lychee-action).

![Lychee demo](./assets/screencast.svg)
<a name="installation"></a>

## Installation

### Arch Linux
Expand Down Expand Up @@ -108,7 +96,7 @@ Lychee supports several feature flags:

By default, `native-tls` and `email-check` are enabled.

<a name="features"></a>

## Features

This comparison is made on a best-effort basis. Please create a PR to fix
Expand Down Expand Up @@ -170,7 +158,6 @@ outdated information.

<sup>1</sup> Other machine-readable formats like CSV are supported.

<a name="cliusage"></a>
## Commandline usage

Recursively check all links in supported files inside the current directory
Expand Down Expand Up @@ -457,7 +444,6 @@ If the `--cache` flag is set, lychee will cache responses in a file called
then the cache will be loaded on startup. This can greatly speed up future runs.
Note that by default lychee will not store any data on disk.

<a name="lib-usage"></a>
## Library usage

You can use lychee as a library for your own projects!
Expand Down Expand Up @@ -558,7 +544,6 @@ If you find a way to make lychee faster, please do reach out.

We collect a list of common workarounds for various websites in our [troubleshooting guide](./docs/TROUBLESHOOTING.md).

<a name="users"></a>
## Users
- https://github.com/InnerSourceCommons/InnerSourcePatterns
- https://github.com/opensearch-project/OpenSearch
Expand Down

0 comments on commit 59847a3

Please sign in to comment.