diff --git a/README.md b/README.md index 71cd9d3..3623373 100644 --- a/README.md +++ b/README.md @@ -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.