Update README

This commit is contained in:
Ajeet D'Souza 2021-03-26 00:06:04 +05:30
parent 40622e9c21
commit 6a67e9444c
1 changed files with 62 additions and 88 deletions

150
README.md
View File

@ -1,5 +1,3 @@
<!-- omit in toc -->
# zoxide # zoxide
[![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide) [![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide)
@ -7,16 +5,11 @@
A faster way to navigate your filesystem A faster way to navigate your filesystem
<!-- omit in toc -->
## Table of contents ## Table of contents
- [Introduction](#introduction) - [Introduction](#introduction)
- [Examples](#examples) - [Examples](#examples)
- [Getting started](#getting-started) - [Getting started](#getting-started)
- [Step 1: Install zoxide](#step-1-install-zoxide)
- [Step 2: Install fzf (optional)](#step-2-install-fzf-optional)
- [Step 3: Add zoxide to your shell](#step-3-add-zoxide-to-your-shell)
- [Configuration](#configuration) - [Configuration](#configuration)
## Introduction ## Introduction
@ -51,8 +44,6 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/ajeetdsou
If you would rather not run a script, you can download the binary from the [Releases](https://github.com/ajeetdsouza/zoxide/releases) page and add it anywhere in your `$PATH`. If you would rather not run a script, you can download the binary from the [Releases](https://github.com/ajeetdsouza/zoxide/releases) page and add it anywhere in your `$PATH`.
<!-- omit in toc -->
#### On Linux #### On Linux
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
@ -68,8 +59,6 @@ If you would rather not run a script, you can download the binary from the [Rele
| Parrot OS | | `apt install zoxide` | | Parrot OS | | `apt install zoxide` |
| Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` | | Void Linux | [Void Linux Packages] | `xbps-install -S zoxide` |
<!-- omit in toc -->
#### On macOS #### On macOS
| Repository | Instructions | | Repository | Instructions |
@ -78,8 +67,6 @@ If you would rather not run a script, you can download the binary from the [Rele
| [Homebrew] | `brew install zoxide` | | [Homebrew] | `brew install zoxide` |
| [MacPorts] | `port install zoxide` | | [MacPorts] | `port install zoxide` |
<!-- omit in toc -->
#### On Windows #### On Windows
| Repository | Instructions | | Repository | Instructions |
@ -87,8 +74,6 @@ If you would rather not run a script, you can download the binary from the [Rele
| [crates.io] | `cargo install zoxide` | | [crates.io] | `cargo install zoxide` |
| [Scoop] | `scoop install zoxide` | | [Scoop] | `scoop install zoxide` |
<!-- omit in toc -->
#### On BSD #### On BSD
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
@ -98,8 +83,6 @@ If you would rather not run a script, you can download the binary from the [Rele
| FreeBSD | [FreshPorts] | `pkg install zoxide` | | FreeBSD | [FreshPorts] | `pkg install zoxide` |
| NetBSD | [pkgsrc] | `pkgin install zoxide` | | NetBSD | [pkgsrc] | `pkgin install zoxide` |
<!-- omit in toc -->
#### On Android #### On Android
| Repository | Instructions | | Repository | Instructions |
@ -112,83 +95,74 @@ If you would rather not run a script, you can download the binary from the [Rele
zoxide for interactive selection. Installation instructions can be found zoxide for interactive selection. Installation instructions can be found
[here](https://github.com/junegunn/fzf#installation). [here](https://github.com/junegunn/fzf#installation).
### Step 3: Add zoxide to your shell ### Step 3: Import your data (optional)
If you currently use `z`, `z.lua`, or `zsh-z`, you may want to first import If you currently use another autojumper, you may want to first import your
your existing entries into `zoxide`: existing entries into zoxide:
```sh | Program | Instructions |
zoxide import /path/to/db | --------------------- | ------------------------------------------- |
``` | `autojump` | `zoxide import --from autojump /path/to/db` |
| `z`, `zsh-z`, `z.lua` | `zoxide import --from z /path/to/db` |
Alternatively, for `autojump`: ### Step 4: Add zoxide to your shell
```sh <table>
zoxide import --from autojump /path/to/db <tr>
``` <th>Shell</th>
<th>Instructions</th>
<!-- omit in toc --> </tr>
<tr></tr>
#### bash <tr>
<th>bash</th>
Add the following line to your `~/.bashrc`: <td>
<p>Add the following line to your <code>~/.bashrc</code>:</p>
```sh <pre lang="bash">eval "$(zoxide init bash)"</pre>
eval "$(zoxide init bash)" </td>
``` </tr>
<tr></tr>
<!-- omit in toc --> <tr>
<th>fish</th>
#### fish <td><p>Add the following line to your<code>~/.config/fish/config.fish</code>:</p>
<pre lang="fish">zoxide init fish | source</pre>
Add the following line to your `~/.config/fish/config.fish`: </td>
</tr>
```sh <tr></tr>
zoxide init fish | source <tr>
``` <th>PowerShell</th>
<td>
<!-- omit in toc --> <p>Add the following line to your profile:</p>
<pre lang="powershell">Invoke-Expression (& {
#### PowerShell
Add the following line to your profile:
```powershell
Invoke-Expression (& {
$hook = if ($PSVersionTable.PSVersion.Major -lt 6) { 'prompt' } else { 'pwd' } $hook = if ($PSVersionTable.PSVersion.Major -lt 6) { 'prompt' } else { 'pwd' }
(zoxide init --hook $hook powershell) -join "`n" (zoxide init --hook $hook powershell) -join "`n"
}) })</pre>
``` </td>
</tr>
<!-- omit in toc --> <tr></tr>
<tr>
#### xonsh <th>xonsh</th>
<td>
Add the following line to your profile (usually `~/.xonshrc`): <p>Add the following line to your profile (usually <code>~/.xonshrc)</code>:</p>
<pre lang="python">execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')</pre>
```xonsh </td>
execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide') </tr>
``` <tr></tr>
<tr>
<!-- omit in toc --> <th>zsh</th>
<td>
#### zsh <p>Add the following line to your <code>~/.zshrc</code>:</p>
<pre lang="zsh">eval "$(zoxide init zsh)"</pre>
Add the following line to your `~/.zshrc`: </td>
</tr>
```sh <tr></tr>
eval "$(zoxide init zsh)" <tr>
``` <th>Any POSIX shell</th>
<td>
<!-- omit in toc --> <p>Add the following line to your shell's configuration file:</p>
<pre lang="sh">eval "$(zoxide init posix --hook prompt)"</pre>
#### Any POSIX shell </td>
</tr>
Add the following line to your shell's configuration file: </table>
```sh
eval "$(zoxide init posix --hook prompt)"
```
## Configuration ## Configuration