Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a Table of Contents for easier navigation #68

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down