Skip to content

Commit

Permalink
Merge pull request #493 from CorentinClabaut/doc
Browse files Browse the repository at this point in the history
Slightly improve documentation
  • Loading branch information
LandonTClipp committed Jul 19, 2022
2 parents 4d1f925 + 178902b commit 1361e94
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -16,7 +16,9 @@ Table of Contents
* [go install](#go-install)
- [Examples](#examples)
+ [Simplest case](#simplest-case)
+ [Function type case](#function-type-case)
+ [Next level case](#next-level-case)
+ [Note](#note)
- [Return Value Provider Functions](#return-value-provider-functions)
+ [Requirements](#requirements)
+ [Notes](#notes)
Expand All @@ -43,6 +45,10 @@ Use the [Docker image](https://hub.docker.com/r/vektra/mockery)

docker pull vektra/mockery

Generate all the mocks for your project:

docker run -v "$PWD":/src -w /src vektra/mockery --all

### Homebrew

Install through [brew](https://brew.sh/)
Expand Down Expand Up @@ -222,6 +228,10 @@ func main() {
}
```

#### Note

For mockery to correctly generate mocks, the command has to be run on a module (i.e. your project has to have a go.mod file)


Return Value Provider Functions
--------------------------------
Expand Down

0 comments on commit 1361e94

Please sign in to comment.