chore: update docs/index.md

This commit is contained in:
Dawid Wysokiński 2023-08-25 07:45:47 +02:00
parent b3c5c0fe54
commit 0dc34c1605
Signed by: Kichiyaki
GPG Key ID: B5445E357FB8B892

View File

@ -10,14 +10,21 @@ description: |-
A Terraform provider used to interact with [Woodpecker CI](https://woodpecker-ci.org/) resources.
## Example Usage
```terraform
provider "woodpecker" {
server = "https://woodpecker.example.com"
token = "token"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
- `server` (String) Woodpecker CI server url. It must be provided, but
- `server` (String) This is the target Woodpecker CI base API endpoint. It must be provided, but
can also be sourced from the WOODPECKER_SERVER environment
variable.
- `token` (String) A Woodpecker CI Personal Access Token. It must be provided, but