From f0a4cef1baa2af1a9bf4ed747163a1a9e469f5ba Mon Sep 17 00:00:00 2001 From: Gergely Brautigam <182850+Skarlso@users.noreply.github.com> Date: Thu, 9 May 2024 12:18:28 +0200 Subject: [PATCH] update readme and add a release note --- README.md | 12 +++++++++++- docs/release_notes/v0.4.0.md | 3 +++ 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 docs/release_notes/v0.4.0.md diff --git a/README.md b/README.md index eed7222..89200f5 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,16 @@ Optionally, you can provide the flag `-s` which will output the generated conten Future plans include generating proper, schema validated values for all fields. +### HTML output + +It's possible to generate a pre-rendered HTML based output for self-hosting what the website produces online. + +To get an HTML output provide the format flag like this: + +``` +cty generate -c delivery.krok.app_krokcommands --comments --format html +``` + ## WASM frontend There is a WASM based frontend that can be started by navigating into the `wasm` folder and running the following make @@ -86,7 +96,7 @@ cty generate -c sample-crd/infrastructure.cluster.x-k8s.io_awsclusters.yaml --co The frontend also has a checkbox to add comments to the generated yaml output. -TODO: add showcase for new frontend. +TODO: add showcase for new frontend. ## Showcase diff --git a/docs/release_notes/v0.4.0.md b/docs/release_notes/v0.4.0.md new file mode 100644 index 0000000..fa2e676 --- /dev/null +++ b/docs/release_notes/v0.4.0.md @@ -0,0 +1,3 @@ +# v0.4.0 Release + +- Add HTML based output formatting (#66)