Merge pull request #5 from alin23/master

Add table of contents
This commit is contained in:
Ajeet D'Souza 2020-03-09 00:17:29 +05:30 committed by GitHub
commit 0aaf806260
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,18 @@
A cd command that learns your habits
## Table of contents
- [Introduction](#introduction)
- [Examples](#examples)
- [Getting started](#getting-started)
- [Installing `zoxide`](#installing-zoxide)
- [Adding `zoxide` to your shell](#adding-zoxide-to-your-shell)
+ [zsh](#zsh)
+ [fish](#fish)
- [Configuration](#configuration)
- [Environment variables](#environment-variables)
## Introduction
`zoxide` is a new `cd` alternative inspired by [`z`](https://github.com/rupa/z) and [`z.lua`](https://github.com/skywind3000/z.lua). It keeps track of the directories you use most frequently, and uses a ranking algorithm to navigate to the best match.