From 81c6810327c4e33c01a8f84e14cd2da148bffaa9 Mon Sep 17 00:00:00 2001 From: Landon Clipp Date: Sun, 21 Jun 2020 22:09:18 -0500 Subject: [PATCH] Update README.md Clean up the readme and update the table of contents. --- README.md | 31 ++++++++++--------------------- 1 file changed, 10 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 76edd17c..9a9e32f1 100644 --- a/README.md +++ b/README.md @@ -7,37 +7,26 @@ mockery mockery provides the ability to easily generate mocks for golang interfaces using the [stretchr/testify/mock](https://pkg.go.dev/github.com/stretchr/testify/mock?tab=doc) package. It removes the boilerplate coding required to use mocks. - - Table of Contents ----------------- - [Installation](#installation) - - [Github Release](#github-release) - - [Docker](#docker) - - [Homebrew](#homebrew) - - [go get](#go-get) + * [Github Release](#github-release) + * [Docker](#docker) + * [Homebrew](#homebrew) + * [go get](#go-get) - [Examples](#examples) - - [Simplest case](#simplest-case) - - [Next level case](#next-level-case) -- [Imports](#imports) -- [Types](#types) + + [Simplest case](#simplest-case) + + [Next level case](#next-level-case) - [Return Value Provider Functions](#return-value-provider-functions) - - [Requirements](#requirements) - - [Notes](#notes) -- [Name](#name) -- [All](#all) -- [Recursive](#recursive) -- [Output](#output) -- [In Package (-inpkg) and KeepTree (-keeptree)](#in-package--inpkg-and-keeptree--keeptree) -- [Specifying File (-filename) and Struct Name (-structname)](#specifying-file--filename-and-struct-name--structname) -- [Casing](#casing) -- [Debug](#debug) + + [Requirements](#requirements) + + [Notes](#notes) +- [Extended Flag Descriptions](#extended-flag-descriptions) - [Mocking interfaces in `main`](#mocking-interfaces-in-main) - [Semantic Versioning](#semantic-versioning) - [Stargazers](#stargazers) - + Installation ------------