Skip to content

Commit 59c0fdb

Browse files
committed
docs: update README.md
1 parent 3b3d8a6 commit 59c0fdb

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# CDViz Community Transformers
1+
# CDviz Community Transformers
22

3-
Community-contributed transformers for [cdviz-collector](https://github.com/cdviz-dev/cdviz-collector) that convert various event sources into [CDEvents](https://cdevents.dev).
3+
Community driven transformers for [cdviz-collector](https://github.com/cdviz-dev/cdviz-collector) that convert various event sources into [CDEvents](https://cdevents.dev).
44

55
## Available Transformers
66

7-
| Transformer | Source | Description |
8-
|-------------|--------|-------------|
9-
| [github_events](./github_events/) | GitHub Webhooks | Converts GitHub events (workflow runs, issues, PRs, releases) to CDEvents |
10-
| [argocd_notifications](./argocd_notifications/) | ArgoCD Webhooks | Converts ArgoCD application lifecycle events to CDEvents |
11-
| [kubewatch_cloudevents](./kubewatch_cloudevents/) | Kubernetes Events | Converts Kubewatch CloudEvents to CDEvents |
12-
| [passthrough](./passthrough/) | CDEvents | Passthrough transformer for existing CDEvents |
7+
| Transformer | Source | Description |
8+
| ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------- |
9+
| [github_events](./github_events/) | GitHub Webhooks | Converts GitHub events (workflow runs, issues, PRs, releases) to CDEvents |
10+
| [argocd_notifications](./argocd_notifications/) | ArgoCD Webhooks | Converts ArgoCD application lifecycle events to CDEvents |
11+
| [kubewatch_cloudevents](./kubewatch_cloudevents/) | Kubernetes Events | Converts Kubewatch CloudEvents to CDEvents |
12+
| [passthrough](./passthrough/) | CDEvents | Passthrough transformer for existing CDEvents |
1313

1414
## Usage
1515

@@ -76,6 +76,8 @@ Contributions are welcome! Each transformer should include:
7676
- `outputs/` - Expected output CDEvents
7777
- `README.md` - Documentation with usage examples
7878

79+
And a command into the `.mise.toml` to test/review the transformer against its inputs.
80+
7981
## License
8082

8183
Apache-2.0

0 commit comments

Comments
 (0)