Skip to content

Commit bcbe891

Browse files
authored
Merge pull request #1802 from gruntwork-io/james/oss-3393-readme-v1
docs(readme): add Install, Stability and versioning sections for v1
2 parents abb96a5 + 182fd29 commit bcbe891

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,23 @@ variety of helper functions and patterns for common infrastructure testing tasks
2222
- Running shell commands
2323
- And much more
2424

25-
Please see the following for more info:
25+
## Install
26+
27+
```bash
28+
go get github.com/gruntwork-io/terratest@latest
29+
```
30+
31+
Requires Go 1.26 or later.
32+
33+
## Stability and versioning
34+
35+
Starting with v1.0.0, Terratest follows [semantic versioning](https://semver.org/). Breaking changes to the public API
36+
only happen in major releases (e.g. v2.0.0).
37+
38+
Symbols renamed or replaced in v1 are kept with `// Deprecated:` annotations pointing at the new name; removals happen
39+
in v2. Migrating from v0.x: see [`MIGRATION.md`](./MIGRATION.md).
40+
41+
## More info
2642

2743
- [Terratest Website](https://terratest.gruntwork.io)
2844
- [Getting started with Terratest](https://terratest.gruntwork.io/docs/getting-started/quick-start/)

0 commit comments

Comments
 (0)