How to: [⏫](#contents) Generate README.md based on GoDoc comments with [goreadme](https://github.com/posener/goreadme)
It can be used as a command line tool, as Github action, or as a pre-commit hook. — [@posener](https://github.com/posener)

```
goreadme
goreadme -variables -functions -methods -badge-godoc
goreadme -badge-godoc -constants -functions -methods -recursive -types -variables > README.md
```

Requirements
```
go install github.com/posener/goreadme/cmd/goreadme@latest
```