From 3cc6de20ac2473c1d79fd8bbeca3fd0986abb6fd Mon Sep 17 00:00:00 2001
From: mataha <mataha@users.noreply.github.com>
Date: Tue, 11 Jun 2024 01:01:56 +0200
Subject: [PATCH] Update documentation

---
 README.md              | 20 ++++++++------------
 man/man1/zoxide-init.1 |  8 ++++----
 man/man1/zoxide.1      |  4 ++--
 3 files changed, 14 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 1448383..c30c802 100644
--- a/README.md
+++ b/README.md
@@ -135,9 +135,6 @@ zoxide can be installed in 4 easy steps:
    <details>
    <summary>Windows</summary>
 
-   > zoxide works with PowerShell, as well as shells running in Cygwin, Git
-   > Bash, and MSYS2.
-   >
    > The recommended way to install zoxide is via `winget`:
    >
    > ```sh
@@ -409,7 +406,7 @@ When calling `zoxide init`, the following flags are available:
 - `--cmd`
   - Changes the prefix of the `z` and `zi` commands.
   - `--cmd j` would change the commands to (`j`, `ji`).
-  - `--cmd cd` would replace the `cd` command.
+  - `--cmd cd` would replace the `cd` command (highly recommended on `cmd.exe`).
 - `--hook <HOOK>`
   - Changes how often zoxide increments a directory's score:
 
@@ -421,8 +418,8 @@ When calling `zoxide init`, the following flags are available:
 
 - `--no-cmd`
   - Prevents zoxide from defining the `z` and `zi` commands.
-  - These functions will still be available in your shell as `__zoxide_z` and
-    `__zoxide_zi`, should you choose to redefine them.
+  - These functions will still be available in your shell (not on `cmd.exe`)
+    as `__zoxide_z` and `__zoxide_zi`, should you choose to redefine them.
 
 ### Environment variables
 
@@ -440,17 +437,16 @@ Environment variables[^2] can be used for configuration. They must be set before
     | Windows     | `%LOCALAPPDATA%`                         | `C:\Users\Alice\AppData\Local`             |
 
 - `_ZO_ECHO`
-  - When set to 1, `z` will print the matched directory before navigating to
-    it.
+  - When set to 1, `z` will print the matched directory after navigating to it.
 - `_ZO_EXCLUDE_DIRS`
   - Excludes the specified directories from the database.
   - This is provided as a list of [globs][glob], separated by OS-specific
     characters:
 
-    | OS                  | Separator | Example                 |
-    | ------------------- | --------- | ----------------------- |
-    | Linux / macOS / BSD | `:`       | `$HOME:$HOME/private/*` |
-    | Windows             | `;`       | `$HOME;$HOME/private/*` |
+    | OS                  | Separator | Example                   |
+    | ------------------- | --------- | ------------------------- |
+    | Linux / macOS / BSD | `:`       | `$HOME:$HOME/private/*`   |
+    | Windows             | `;`       | `%HOME%;%HOME%/private/*` |
 
   - By default, this is set to `"$HOME"`.
 - `_ZO_FZF_OPTS`
diff --git a/man/man1/zoxide-init.1 b/man/man1/zoxide-init.1
index 9ea1361..6a2e706 100644
--- a/man/man1/zoxide-init.1
+++ b/man/man1/zoxide-init.1
@@ -98,8 +98,8 @@ Changes the prefix of the \fBz\fR and \fBzi\fR commands.
 .br
 \fB--cmd j\fR would change the commands to (\fBj\fR, \fBji\fR).
 .br
-\fB--cmd cd\fR would replace the \fBcd\fR command (doesn't work on Nushell /
-POSIX shells).
+\fB--cmd cd\fR would replace the \fBcd\fR command (highly recommended on
+\fBcmd.exe\fR).
 .TP
 .B -h, --help
 Print help information.
@@ -116,8 +116,8 @@ l l.
 .TP
 .B --no-cmd
 Prevents zoxide from defining the \fBz\fR and \fBzi\fR commands. These functions
-will still be available in your shell as \fB__zoxide_z\fR and \fB__zoxide_zi\fR,
-should you choose to redefine them.
+will still be available in your shell (not on \fBcmd.exe\fR) as \fB__zoxide_z\fR
+and \fB__zoxide_zi\fR, should you choose to redefine them.
 .SH REPORTING BUGS
 For any issues, feature requests, or questions, please visit:
 .sp
diff --git a/man/man1/zoxide.1 b/man/man1/zoxide.1
index ef1792b..5ee7c0c 100644
--- a/man/man1/zoxide.1
+++ b/man/man1/zoxide.1
@@ -70,7 +70,7 @@ T}
 .TE
 .TP
 .B _ZO_ECHO
-When set to 1, \fBz\fR will print the matched directory before navigating to it.
+When set to 1, \fBz\fR will print the matched directory after navigating to it.
 .TP
 .B _ZO_EXCLUDE_DIRS
 Prevents the specified directories from being added to the database. This is
@@ -82,7 +82,7 @@ l l.
     \fBLinux/macOS/BSD\fR|T{
 \fB:\fR, eg. \fB$HOME:$HOME/private/*\fR
 T}
-    \fBWindows\fR|\fB;\fR, eg. \fB$HOME;$HOME/private/*\fR
+    \fBWindows\fR|\fB;\fR, eg. \fB%HOME%;%HOME%/private/*\fR
 .TE
 .sp
 By default, this is set to \fB$HOME\fR. After setting this up, you might need