From d68d8e195eb7bca861e9cd5083abffe1b220bda7 Mon Sep 17 00:00:00 2001 From: Martin Fieber Date: Fri, 24 Nov 2017 16:42:38 +0100 Subject: [PATCH] docs: add contents list to readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe6d750f5a..39ee233964 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,23 @@ * 📦 Share configuration via `npm` * 🤖 Tap into `conventional-changelog` +## Contents + +* [Getting started](#getting-started) +* [CLI](#cli) +* [Config](#config) +* [Shared configuration](#shared-configuration) +* [API](#api) +* [Tools](#tools) +* [Version Support](#version-support) +* [Related projects](#related-projects) +* [License](#license) +* [Development](#development) + * [Install and run](#install-and-run) + * [Publishing a release](#publishing-a-release) + +* * * + ## Getting started ```sh @@ -79,7 +96,7 @@ Copyright by @marionebl. All `commitlint` packages are released under the MIT li `commitlint` is developed in a mono repository. -### Getting started +### Install and run ```sh git clone git@github.com:marionebl/commitlint.git