Skip to content

Commit

Permalink
README updates (#220)
Browse files Browse the repository at this point in the history
The Admin API is covered now, and package documentation is at pkg.go.dev
  • Loading branch information
chrisarcand authored May 18, 2021
1 parent 7104d5b commit db513c3
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,7 @@ if err != nil {

## Documentation

For complete usage of the API client, see the full [package docs](https://godoc.org/github.com/hashicorp/go-tfe).

## API Coverage

Most of the [Terraform Cloud/Enterprise V2 API](https://www.terraform.io/docs/cloud/api/index.html) is supported in this
client. Currently, the separate [Admin API](https://www.terraform.io/docs/cloud/api/admin/index.html) - applicable only
to Terraform Enterprise - is not.

For complete usage of the API client, see the full [package docs](https://pkg.go.dev/github.com/hashicorp/go-tfe).

## Examples

Expand Down Expand Up @@ -98,18 +91,18 @@ Documentation updates and test fixes that only touch test files don't require a
- ENHANCEMENTS: Use this for smaller new features added
- BUG FIXES: Use this for any bugs that were fixed.
- NOTES: Use this section if you need to include any additional notes on things like upgrading, upcoming deprecations, or any other information you might want to highlight.

Markdown example:

```markdown
ENHANCEMENTS
* Add description of new small feature (#3)[link-to-pull-request]

BUG FIXES
* Fix description of a bug (#2)[link-to-pull-request]
* Fix description of another bug (#1)[link-to-pull-request]
```

- Don't attach any binaries. The zip and tar.gz assets are automatically created and attached after you publish your release.
- Click "Publish release" to save and publish your release.

0 comments on commit db513c3

Please sign in to comment.