Skip to content

docs: add contents list to readme #154

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 24, 2017
Merged

docs: add contents list to readme #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down