docs: improve README, remove duplicate example

pub-solar · Apr 26, 2023 · 12236c4 · 12236c4
1 parent a9ce907
commit 12236c4
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 35 deletions.
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 default: install
 
-generate:
+docs:
 	go generate ./...
 
 install:

diff --git a/README.md b/README.md
@@ -2,14 +2,27 @@
 
 Currently only supports maintaining DNS Zones and Records.
 
+- [Provider documentation](https://registry.terraform.io/providers/pub-solar/hostingde/latest/docs)
+
 ### Environment variables for provider configuration
 - Required: `HOSTINGDE_AUTH_TOKEN`, go to your [hosting.de profile](https://secure.hosting.de/profile) and create an API Key
 - Optional: `HOSTINGDE_ACCOUNT_ID`
 
 ### Quick start
+Copy the example `main.tf`, then run the following commands:
+
+```shell
+export HOSTINGDE_AUTH_TOKEN=your-token
+```
 ```shell
 terraform init
 ```
+```shell
+terraform plan -out "hostingde.plan"
+```
+```shell
+terraform apply "hostingde.plan"
+```
 
 ### Example `main.tf`
 ```
@@ -152,6 +165,12 @@ Compile and install the provider into your `$GOPATH/bin`
 make install
 ```
 
+Generate documentation to `docs/`
+
+```shell
+make docs
+```
+
 Run resource tests
 ```shell
 export HOSTINGDE_AUTH_TOKEN=YOUR-API-TOKEN

diff --git a/example/main.tf b/example/main.tf