Skip to content

Commit

Permalink
correct readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nieomylnieja committed Jun 17, 2024
1 parent 2900f5b commit c38aa05
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions internal/cmd/objectimpl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ It utilizes `text/template` to generate the code.

## Usage

```shell
go run . -o docs.yaml
Add the following `generate` directive to the file that contains the `manifest.Object` object definition.
Replace the `<OBJECT_KIND>` with the struct name of your object, e.g. `Project`.

```go
//go:generate go run ../../../internal/cmd/objectimpl <OBJECT_KIND>
```

0 comments on commit c38aa05

Please sign in to comment.