Skip to content

Commit

Permalink
add semver info and link to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kmoe authored Nov 18, 2020
1 parent b124e41 commit afb6b28
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ A Go module for constructing and running [Terraform](https://terraform.io) CLI c

The [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) is the canonical Go interface for Terraform plugins using the gRPC protocol. This library is intended for use in Go programs that make use of Terraform's other interface, the CLI. Importing this library is preferable to importing `github.com/hashicorp/terraform/command`, because the latter is not intended for use outside Terraform Core.

While terraform-exec is already widely used, please note that this module is **not yet at v1.0.0**, and that therefore breaking changes may occur in minor releases.

We strictly follow [semantic versioning](https://semver.org).

## Usage

The `Terraform` struct must be initialised with `NewTerraform(workingDir, execPath)`.
Expand Down Expand Up @@ -60,3 +64,7 @@ func main() {
fmt.Println(state.FormatVersion) // "0.1"
}
```

## Contributing

Please see [CONTRIBUTING.md](./CONTRIBUTING.md).

0 comments on commit afb6b28

Please sign in to comment.