docs: Fixup examples for the Terraform Registry - define params etc.

Author: issyl0

docs/example.tf

@@ -1,14 +1,24 @@
-# terraform-provider-improvmx
+# ImprovMX Terraform Provider
 
-A very nascent Terraform provider for configuring [ImprovMX](https://improvmx.com) email forwards. Uses my [ImprovMX Golang API client](https://github.com/issyl0/go-improvmx). Download from the [Terraform Registry](https://registry.terraform.io/providers/issyl0/improvmx/latest).
+A community Terraform provider for configuring [ImprovMX](https://improvmx.com) domains and their email forwarding rules.
 
-## Features
+## Example Usage
 
-- Create a domain (ImprovMX creates a wildcard forward for a domain by default).
-- Update a domain (to add/remove whitelabel (Enterprise plans only) and notification email settings).
-- Delete a domain.
-- Import a domain.
-- Create an email forward.
-- Delete an email forward.
-- Import an email forward.
-- Update an email forward (ImprovMX allows updating an email forward to send to more than one address, ie `[email protected],[email protected]`).
+```hcl
+terraform {
+  required_providers {
+    improvmx = {
+      source  = "issyl0/improvmx"
+      version = "0.1.0"
+    }
+  }
+}
+
+provider "improvmx" {
+  token = "YOUR API TOKEN HERE"
+}
+```
+
+## Argument Reference
+
+* `token` - ImprovMX API token, alternatively set the `IMPROVMX_API_TOKEN` environment variable.

docs/index.md

@@ -0,0 +1,26 @@
+# `improvmx_domain` Resource
+
+A resource to create ImprovMX domains.
+
+## Example Usage
+
+```hcl
+// ImprovMX creates a wildcard email forward on each domain by default.
+resource "improvmx_domain" "example" {
+  domain = "example.com"
+}
+```
+
+## Argument Reference
+
+* `domain` - (Required) Name of the domain.
+* `notification_email` - (Optional) Email to send notifications to.
+* `whitelabel` - (Optional) Parent domain that will be displayed for the DNS settings. Only available on the Enterprise plan.
+
+## Import
+
+Domains can be imported using their name, for example:
+
+```shell
+$ terraform import improvmx_domain.example example.com
+```

docs/resources/improvmx_domain.md

@@ -0,0 +1,39 @@
+# `improvmx_email_forward` Resource
+
+A resource to create ImprovMX email forwards.
+
+## Example Usage
+
+### Single recipient
+
+```hcl
+resource "improvmx_email_forward" "example" {
+  domain            = "example.com"
+  alias_name        = "reception"
+  destination_email = "[email protected]"
+}
+```
+
+### Multiple recipients
+
+```hcl
+resource "improvmx_email_forward" "sales" {
+  domain            = "example.com"
+  alias_name        = "sales"
+  destination_email = "[email protected],[email protected]"
+}
+```
+
+## Argument Reference
+
+* `domain` - (Required) Name of the domain.
+* `alias_name` - (Required) Alias to be used in front of your domain, like "contact", "info", etc.
+* `destination_email` - (Required) Email address to forward to.
+
+## Import
+
+Email forwards can be imported using their name, for example:
+
+```shell
+$ terraform import improvmx_email_forward.example example.com_hello
+```