From c6e4b3dc0ebac80d961a96b681e9f4b9b0a08bf2 Mon Sep 17 00:00:00 2001 From: Cory Bennett Date: Mon, 18 Sep 2017 00:49:34 -0700 Subject: [PATCH] add TOC --- Makefile | 2 +- README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index bed952e..5c5bdc7 100644 --- a/Makefile +++ b/Makefile @@ -68,7 +68,7 @@ update-changelog: release: perl -pi -e 'undef $$/; s/\n```\nusage.*```//sg' README.md echo '```' >> README.md - ./jira --help >> README.md || true + ./jira --help >> README.md 2>&1 || true echo '```' >> README.md git diff --exit-code --quiet README.md || git commit -m "Updated Usage" README.md git commit -m "Updated Changelog" CHANGELOG.md diff --git a/README.md b/README.md index a1869c0..240406d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,34 @@ [![GoDoc](https://godoc.org/gopkg.in/Netflix-Skunkworks/go-jira.v1?status.svg)](https://godoc.org/gopkg.in/Netflix-Skunkworks/go-jira.v1) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +Table of Contents +================= + + * [Install](#install) + * [Download](#download) + * [Build](#build) + * [v1 vs v0 changes](#v1-vs-v0-changes) + * [Golang library import](#golang-library-import) + * [Configs per command](#configs-per-command) + * [Custom Commands](#custom-commands) + * [Incompatible command changes](#incompatible-command-changes) + * [Login process change](#login-process-change) + * [Configuration](#configuration) + * [Dynamic Configuration](#dynamic-configuration) + * [Custom Commands](#custom-commands-1) + * [Commands](#commands) + * [Options](#options) + * [Arguments](#arguments) + * [Script Template](#script-template) + * [Examples](#examples) + * [Editing](#editing) + * [Templates](#templates) + * [Writing/Editing Templates](#writingediting-templates) + * [Authentication](#authentication) + * [keyring password source](#keyring-password-source) + * [pass password source](#pass-password-source) + * [Usage](#usage) + # go-jira simple command line client for Atlassian's Jira service written in Go