Skip to content

Commit 12236c4

Browse files
committed
docs: improve README, remove duplicate example
1 parent a9ce907 commit 12236c4

File tree

3 files changed

+20
-35
lines changed

3 files changed

+20
-35
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
default: install
22

3-
generate:
3+
docs:
44
go generate ./...
55

66
install:

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,27 @@
22

33
Currently only supports maintaining DNS Zones and Records.
44

5+
- [Provider documentation](https://registry.terraform.io/providers/pub-solar/hostingde/latest/docs)
6+
57
### Environment variables for provider configuration
68
- Required: `HOSTINGDE_AUTH_TOKEN`, go to your [hosting.de profile](https://secure.hosting.de/profile) and create an API Key
79
- Optional: `HOSTINGDE_ACCOUNT_ID`
810

911
### Quick start
12+
Copy the example `main.tf`, then run the following commands:
13+
14+
```shell
15+
export HOSTINGDE_AUTH_TOKEN=your-token
16+
```
1017
```shell
1118
terraform init
1219
```
20+
```shell
21+
terraform plan -out "hostingde.plan"
22+
```
23+
```shell
24+
terraform apply "hostingde.plan"
25+
```
1326

1427
### Example `main.tf`
1528
```
@@ -152,6 +165,12 @@ Compile and install the provider into your `$GOPATH/bin`
152165
make install
153166
```
154167

168+
Generate documentation to `docs/`
169+
170+
```shell
171+
make docs
172+
```
173+
155174
Run resource tests
156175
```shell
157176
export HOSTINGDE_AUTH_TOKEN=YOUR-API-TOKEN

example/main.tf

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)