Skip to content

Commit

Permalink
docs: add separate section on codegen from proto
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikaverpil committed Nov 4, 2024
1 parent 8609a18 commit 94d6868
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,26 @@
Go SDK for implementing [Google API Improvement Proposals](https://aip.dev/)
(AIP).

## Example library usage
## Generate AIP support code from proto

```bash
go install go.einride.tech/aip/cmd/protoc-gen-go-aip
```

Add to `buf.gen.yaml`:

```yaml
version: v2
plugins:
- local: protoc-gen-go-aip
out: gen
opt:
- paths=source_relative
```
Run `buf build` to generate e.g. `your_service_aip.go`.

## Library usage examples

```bash
go get -u go.einride.tech/aip
Expand Down

0 comments on commit 94d6868

Please sign in to comment.