Skip to content

Commit

Permalink
Update README.md - add tools.go quick example (#289)
Browse files Browse the repository at this point in the history
* Update README.md

---------

Co-authored-by: Selena Goods <github@simplebox.anonaddy.com>
  • Loading branch information
thiskevinwang and SBGoods committed Jan 11, 2024
1 parent 068a226 commit eff4087
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,29 @@ You can install a copy of the binary manually from the [releases](https://github
or you can optionally use the [tools.go model](https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md)
for tool installation.

> [!NOTE]
>
> Here is a brief `./tools/tools.go` example from https://github.com/hashicorp/terraform-provider-scaffolding-framework:
>
> ```go
> //go:build tools
>
> package tools
>
> import (
> // Documentation generation
> _ "github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs"
> )
> ```
>
> Then run the following to install and verify `tfplugindocs`:
> ```console
> export GOBIN=$PWD/bin
> export PATH=$GOBIN:$PATH
> go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
> which tfplugindocs
> ```
### Usage
```shell
Expand Down

0 comments on commit eff4087

Please sign in to comment.