From 28a888a6cf97c2953555963bc1318e17b711ec7d Mon Sep 17 00:00:00 2001 From: Juan Ibiapina Date: Mon, 15 Jul 2024 14:22:11 +0200 Subject: [PATCH] doc: Add table of contents to README --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c83f06..570b516 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,33 @@ It allows the dynamic creation of a CLI from a directory (and subdirectories) of scripts with support for documentation, argument validation, and completions. -Use the Github table of contents on the top right of this README to navigate -the documentation. +## Table of Contents + + + +* [Key features](#key-features) +* [Demo](#demo) +* [Installation](#installation) +* [Setup](#setup) + * [Examples](#examples) + * [As an alias](#as-an-alias) + * [As an executable](#as-an-executable) +* [Usage](#usage) +* [Documenting commands](#documenting-commands) +* [Validating arguments](#validating-arguments) +* [Parsing arguments](#parsing-arguments) +* [Completions](#completions) +* [Nested subcommands](#nested-subcommands) +* [Aliases](#aliases) +* [Sharing code between scripts](#sharing-code-between-scripts) +* [Caching](#caching) +* [Migrating to Sub 2.x](#migrating-to-sub-2x) + * [change --bin to --executable](#change---bin-to---executable) + * [Usage comments](#usage-comments) + * [Help, commands and completions](#help-commands-and-completions) +* [Inspiration](#inspiration) + + ## Key features