From c72416d5706e04cda8b53b529113d9b497511965 Mon Sep 17 00:00:00 2001 From: Niels Bom Date: Wed, 1 May 2024 15:51:30 +0200 Subject: [PATCH] README.md - refer to man pages Not everybody's first instinct is to `man zoxide` so let's be explicit. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e2248ff..8a58465 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ zoxide works on all major shells. [Getting started](#getting-started) • [Installation](#installation) • [Configuration](#configuration) • +[Usage](#usage) • [Integrations](#third-party-integrations) @@ -427,6 +428,18 @@ Environment variables[^2] can be used for configuration. They must be set before - When set to 1, `z` will resolve symlinks before adding directories to the database. +## Usage + +Zoxide uses [man pages](https://en.wikipedia.org/wiki/Man_page) for its documentation. To see them: + +```shell +man zoxide +# For the subcommands +man zoxide-query +``` + +You can find [these man pages online](https://www.mankier.com/1/zoxide) too. + ## Third-party integrations | Application | Description | Plugin |