From cd0736b0f02ba73b63e448dfd0a5c6cc18f5a758 Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Mon, 29 Aug 2022 16:55:09 -0400 Subject: [PATCH] docs: add a Table of Contents for easier navigation - e.g. installation is at the very bottom, so being able to quickly click to get there would be helpful (IMO) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 1a081d4..fb0df62 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,21 @@ This is a bug fix release: v0.6.4-with-no-mangle-double-dash This release will be maintained for compatibility, only fixes will be provided. The 0.6.4 version is fully compatible with the previous version of `docopts`. Except for `-` handling in global mode, which produces an error. +## Table of Contents + +- [SYNOPSIS](#synopsis) +- [DESCRIPTION](#description) +- [OPTIONS](#options) +- [COMPATIBILITY](#compatibility) +- [`docopts.sh` helper](#docoptssh-helper) +- [EXAMPLES](#examples) +- [Docopts History](#docopts-history) +- [Roadmap: A new shell API is proposed](#roadmap-a-new-shell-api-is-proposed) +- [Install](#install) +- [Compiling](#compiling) +- [Features](#features) +- [Developers](#developers) + ## SYNOPSIS [make README.md]: # (./docopts --help | get_usage)