📝 update docs

docs/index.md

@@ -1,15 +1,68 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "openstatus Provider"
+page_title: "OpenStatus Provider"
 subcategory: ""
 description: |-
-  
+
 ---
 
-# openstatus Provider
+# OpenStatus Provider
+
+The [OpenStatus](https://www.openstatus.dev) provider is used to interact with the resources supported by OpenStatus. The provider needs to be configured with the proper credentials before it can be used.
+
+
+## Example Usage
+
+```hcl
+
+terraform {
+  required_providers {
+    openstatus = {
+      source = "openstatusHQ/openstatus"
+    }
+  }
+}
+
+provider "openstatus" {
+  openstatus_api_token = "your-key"
+}
 
 
+resource "openstatus_monitor" "my_monitor" {
+  url            = "https://www.openstatus.dev"
+  regions        = ["iad", "jnb", "ams"]
+  periodicity    = "10m"
+  name           = "test-monitor"
+  degraded_after = 30
+  timeout        = 13
+  active         = false
+  description    = "This is a test monitor"
+  headers = [
+    { key = "test-key", value = "test-value" },
+  ]
+  assertions = [
+    {
+      type    = "status"
+      target  = "200"
+      key     = ""
+      compare = "eq"
+    },
+    {
+      type    = "status"
+      target  = "300"
+      key     = ""
+      compare = "eq"
+    },
+    {
+      type    = "header"
+      target  = "test"
+      key     = "test"
+      compare = "eq"
+    }
+  ]
+}
 
+```
 
 
 <!-- schema generated by tfplugindocs -->

docs/resources/monitor.md

@@ -3,12 +3,12 @@
 page_title: "openstatus_monitor Resource - terraform-provider-openstatus"
 subcategory: ""
 description: |-
-  
+
 ---
 
 # openstatus_monitor (Resource)
 
-
+<https://docs.openstatus.dev/synthetic/features/monitor>
 
 
 

examples/main.tf

@@ -1,8 +1,7 @@
 terraform {
   required_providers {
     openstatus = {
-      source = "openstatus.dev/tf/openstatus"
-
+      source = "openstatusHQ/openstatus"
     }
   }
 }

main.tf

@@ -1,9 +1,7 @@
 terraform {
   required_providers {
     openstatus = {
-      source = "openstatus.dev/tf/openstatus"
-      # version = "~> 0.0.2"
-
+      source = "openstatusHQ/openstatus"
     }
   }
 }
@@ -12,16 +10,6 @@ provider "openstatus" {
   openstatus_api_token = "your-key"
 }
 
-# resource "openstatus_monitor" "my_monitor" {
-#   url   = "https://www.openstatus.dev"
-#   regions= ["iad", "jnb"]
-#   periodicity =  "10m"
-#   name = "test-monitor"
-#   active = true
-#   description = "This is a test monitor"
-# }
-
-
 
 resource "openstatus_monitor" "my_monitor" {
   url            = "https://www.openstatus.dev"