Skip to content

Commit

Permalink
update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Skarlso committed May 25, 2024
1 parent de54a01 commit ae20ae8
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ A single file will be created containing all versions in the CRD delimited by `-

Optionally, you can provide the flag `-s` which will output the generated content to `stdout`.

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.
Expand Down Expand Up @@ -79,6 +77,16 @@ To run cty with minimal required fields, pass in `--minimal` to the command like
cty generate -c delivery.krok.app_krokcommands --comments --minimal --format html
```

### Folder source

To parse mutliple CRDs in a single folder, just pass in the whole folder like this:

```
cty generate -r folder
```

Any other flag will work as before.

## WASM frontend

There is a WASM based frontend that can be started by navigating into the `wasm` folder and running the following make
Expand Down

0 comments on commit ae20ae8

Please sign in to comment.