From eff4087f0c37ea25f8d032ccf87d0d833f4dc45f Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 11 Jan 2024 15:26:21 -0500 Subject: [PATCH] Update README.md - add `tools.go` quick example (#289) * Update README.md --------- Co-authored-by: Selena Goods --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index ac96c2e7..4a4ffb72 100644 --- a/README.md +++ b/README.md @@ -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