updates to make this more useful

Author: ndbroadbent

README.md

@@ -2,6 +2,11 @@
 
 Terraform provider for LogStruct: type-safe CloudWatch filter patterns and LogStruct metadata validation at plan time.
 
+Links:
+- Website: https://logstruct.com/
+- LogStruct (Ruby gem): https://github.com/DocSpring/logstruct
+- Provider (this repo): https://github.com/DocSpring/terraform-provider-logstruct
+
 ## Features
 
 - Validate that a `struct` and `event` combination is valid based on LogStruct's typed definitions.
@@ -34,22 +39,19 @@ Outputs:
 
 - `pattern` (string): CloudWatch filter pattern `{ $.src = "mailer" && $.evt = "delivered" ... }`
 
-## Provider Configuration
+## Installation
 
 ```hcl
-provider "logstruct" {
-  export_dir = "./site/lib/log-generation"
+terraform {
+  required_providers {
+    logstruct = {
+      source  = "DocSpring/logstruct"
+      version = ">= 0.0.3"
+    }
+  }
 }
 ```
 
-`export_dir` should contain:
-
-- `sorbet-enums.json`
-- `sorbet-log-structs.json`
-- `log-keys.json`
-
-These are generated by LogStruct's existing exporters.
-
 ## Example
 
 ```hcl
@@ -73,6 +75,8 @@ resource "aws_cloudwatch_log_metric_filter" "email_delivered_count" {
 }
 ```
 
+See more examples at https://logstruct.com/docs/terraform.
+
 ## Releasing
 
 Use GoReleaser to build and publish GitHub releases with platform-specific zips and checksums. Tags must be semantic versions prefixed with `v` (e.g. `v0.1.0`).

docs/data-sources/cloudwatch_filter.md

@@ -0,0 +1,40 @@
+# logstruct_cloudwatch_filter (Data Source)
+
+Compiles a CloudWatch Logs JSON filter pattern for a given LogStruct `struct` and `event`. The provider validates the combination at plan time against the embedded catalog generated from LogStruct releases.
+
+## Example Usage
+
+```hcl
+data "logstruct_cloudwatch_filter" "email_delivered" {
+  struct = "ActionMailer"
+  event  = "delivered"
+}
+
+resource "aws_cloudwatch_log_metric_filter" "email_delivered_count" {
+  name           = "Email Delivered Count"
+  log_group_name = var.log_group.app
+  pattern        = data.logstruct_cloudwatch_filter.email_delivered.pattern
+
+  metric_transformation {
+    name      = "app_email_delivered_count"
+    namespace = var.namespace.logs
+    value     = "1"
+    unit      = "Count"
+  }
+}
+```
+
+## Argument Reference
+
+- `struct` (String, Required) — LogStruct struct name (e.g., `ActionMailer`, `GoodJob`, `SQL`).
+- `event` (String, Required) — Serialized event value for the struct (e.g., `delivered`, `finish`, `database`).
+- `predicates` (Map(List(String)), Optional) — Additional equality predicates to include in the filter. Keys are JSON paths relative to the root (without `$.`), values are lists of accepted values.
+
+## Attributes Reference
+
+- `pattern` (String) — Compiled CloudWatch Logs filter pattern, for example:
+
+  ```
+  { $.src = "mailer" && $.evt = "delivered" }
+  ```
+

docs/data-sources/filters.md

@@ -0,0 +1,39 @@
+# logstruct_filters (Data Source)
+
+Aggregated, catalog-driven helpers for LogStruct:
+
+- `filters`: Map of struct name → (map of event → CloudWatch filter `pattern`).
+- `events`: Map of struct name → list of allowed events.
+- `sources`: Map of struct name → fixed source (if any).
+- `keys`: Canonical key names for common fields (e.g., `evt`, `src`).
+
+## Example Usage
+
+```hcl
+data "logstruct_filters" "all" {}
+
+locals {
+  email_delivered = data.logstruct_filters.all.filters["ActionMailer"]["delivered"]
+}
+
+resource "aws_cloudwatch_log_metric_filter" "email_delivered_count" {
+  name           = "Email Delivered Count"
+  log_group_name = var.log_group.app
+  pattern        = local.email_delivered
+
+  metric_transformation {
+    name      = "app_email_delivered_count"
+    namespace = var.namespace.logs
+    value     = "1"
+    unit      = "Count"
+  }
+}
+```
+
+## Attributes Reference
+
+- `filters` (Map(Map(String)))
+- `events` (Map(List(String)))
+- `sources` (Map(String))
+- `keys` (Map(String))
+

docs/data-sources/pattern.md

@@ -0,0 +1,36 @@
+# logstruct_pattern (Data Source)
+
+Compiles a CloudWatch Logs JSON filter pattern for a given `source` and `event`.
+The provider validates the combination at plan-time against the embedded catalog.
+
+## Example Usage
+
+```hcl
+data "logstruct_pattern" "email_delivered" {
+  source = "mailer"
+  event  = var.event
+}
+
+resource "aws_cloudwatch_log_metric_filter" "email_delivered_count" {
+  name           = "Email Delivered Count"
+  log_group_name = var.log_group.app
+  pattern        = data.logstruct_pattern.email_delivered.pattern
+
+  metric_transformation {
+    name      = "app_email_delivered_count"
+    namespace = var.namespace.logs
+    value     = "1"
+    unit      = "Count"
+  }
+}
+```
+
+## Argument Reference
+
+- `source` (String, Required) — Canonical source value (e.g., `mailer`, `job`).
+- `event` (String, Required) — Serialized event value (e.g., `delivered`, `finish`).
+
+## Attributes Reference
+
+- `pattern` (String) — Compiled CloudWatch filter pattern.
+

docs/data-sources/source.md

@@ -0,0 +1,32 @@
+# logstruct_source (Data Source)
+
+Validates a canonical `source` (e.g., `mailer`, `job`, `rails`, `storage`) and returns:
+
+- `canonical`: The canonical source string (echoed).
+- `events`: A map of allowed events for this source (keys and values are the same), suitable for `contains(keys(...), var.event)` validation.
+
+## Example Usage
+
+```hcl
+data "logstruct_source" "mailer" {
+  source = "mailer"
+}
+
+variable "event" {
+  type = string
+  validation {
+    condition     = contains(keys(data.logstruct_source.mailer.events), var.event)
+    error_message = "Invalid event for source=mailer"
+  }
+}
+```
+
+## Argument Reference
+
+- `source` (String, Required)
+
+## Attributes Reference
+
+- `canonical` (String)
+- `events` (Map(String))
+

docs/index.md

@@ -0,0 +1,46 @@
+# LogStruct Provider
+
+The LogStruct Terraform provider offers type-safe helpers for working with LogStruct JSON logs:
+
+- Validate struct/event combinations at plan-time using the provider’s embedded catalog.
+- Generate CloudWatch Logs filter patterns without hand-writing stringly-typed expressions.
+
+## Example Usage
+
+```hcl
+terraform {
+  required_providers {
+    logstruct = {
+      source  = "DocSpring/logstruct"
+      version = ">= 0.0.3"
+    }
+  }
+}
+
+data "logstruct_cloudwatch_filter" "email_delivered" {
+  struct = "ActionMailer"
+  event  = "delivered"
+}
+
+resource "aws_cloudwatch_log_metric_filter" "email_delivered_count" {
+  name           = "Email Delivered Count"
+  log_group_name = var.log_group.app
+  pattern        = data.logstruct_cloudwatch_filter.email_delivered.pattern
+
+  metric_transformation {
+    name      = "app_email_delivered_count"
+    namespace = var.namespace.logs
+    value     = "1"
+    unit      = "Count"
+  }
+}
+```
+
+## Argument Reference
+
+This provider uses an embedded catalog exported from LogStruct releases, so it requires no configuration.
+
+## Import
+
+This provider has no importable resources.
+