Skip to content

Commit 3c7c9b5

Browse files
committed
Add notes about maintenance and expectations
1 parent 92a2f30 commit 3c7c9b5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
[![Go Report Card](https://goreportcard.com/badge/github.com/burbon/terraform-provider-restapi)](https://goreportcard.com/report/github.com/burbon/terraform-provider-restapi)
44
# Terraform provider for generic REST APIs
55

6+
## Maintenance Note
7+
This provider is largely feature-complete and in maintenance mode.
8+
* It's not dead - it's just slow moving and updates must be done very carefully
9+
* We encourage community participation with open issues for usage and remain welcoming of pull requests
10+
* Code updates happen sporadically throughout the year, driven primarily by security fixes and PRs
11+
* Because of the many API variations and flexibility of this provider, detailed per-API troubleshooting cannot be guaranteed
12+
13+
 
14+
15+
## About This Provider
616
This terraform provider allows you to interact with APIs that may not yet have a first-class provider available by implementing a "dumb" REST API client.
717

818
This provider is essentially created to be a terraform-wrapped `cURL` client. Because of this, you need to know quite a bit about the API you are interacting with as opposed to full-featured terraform providers written with a specific API in mind.

0 commit comments

Comments
 (0)