From 8605a8d3c1a595d7c15824ab0180c20da61fc1c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= Date: Sat, 11 Mar 2023 19:20:23 +0300 Subject: [PATCH] docs(readme): add table of contents --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f3bbfd..ad1fc7a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,40 @@ On the other hand, if you _really_ need help, you can use the `plz` subcommand w 1. show the **man page** (runs [`man(1)`](https://man7.org/linux/man-pages/man1/man.1.html)) 2. show the **cheat sheet** (via [`cheat.sh`](http://cheat.sh)) +
+ Table of Contents + + + +- [Example](#example) +- [Installation](#installation) + - [Cargo](#cargo) + - [Arch Linux](#arch-linux) + - [Docker](#docker) + - [Images](#images) + - [Usage](#usage) + - [Building](#building) + - [Binary releases](#binary-releases) + - [Build from source](#build-from-source) +- [Usage](#usage-1) + - [`plz`](#plz) +- [Examples](#examples) + - [Check `help` and `version` (default)](#check-help-and-version-default) + - [Check a custom argument](#check-a-custom-argument) + - [Disable defaults](#disable-defaults) + - [Verbose logging](#verbose-logging) + - [Get additional help (via `plz`)](#get-additional-help-via-plz) + - [Custom pager](#custom-pager) +- [Configuration](#configuration) +- [Funding](#funding) +- [Contributing](#contributing) +- [License](#license) +- [Copyright](#copyright) + + + +
+ ### Example Have you ever experienced this: @@ -289,7 +323,7 @@ halp plz --no-pager bat vim See [halp.toml](config/halp.toml) for the default configuration values. -### Funding +## Funding If you find `halp` and/or other projects on my [GitHub profile](https://github.com/orhun/) useful, consider supporting me on [GitHub Sponsors](https://github.com/sponsors/orhun) or [becoming a patron](https://www.patreon.com/join/orhunp)!