Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
  • Loading branch information
rustatian committed Jul 9, 2023
1 parent ea60337 commit e7681ac
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</a>
</p>
<p align="center">
<a href="https://packagist.org/packages/spiral/roadrunner"><img src="https://poser.pugx.org/spiral/roadrunner/version"></a>
<a href="https://packagist.org/packages/roadrunner-server/roadrunner"><img src="https://poser.pugx.org/roadrunner-server/roadrunner/version"></a>
<a href="https://pkg.go.dev/github.com/roadrunner-server/api/v4?tab=doc"><img src="https://godoc.org/github.com/roadrunner-server/api/v4?status.svg"></a>
<a href="https://github.com/roadrunner-server/api/actions"><img src="https://github.com/roadrunner-server/api/workflows/Linters/badge.svg" alt=""></a>
<a href="https://goreportcard.com/report/github.com/roadrunner-server/api"><img src="https://goreportcard.com/badge/github.com/roadrunner-server/api"></a>
Expand All @@ -16,23 +16,25 @@

# RoadRunner API

## ALL protobuf API located here: [Buf](https://buf.build/roadrunner-server/api)
To install and use generated packages:
```bash
go get go.buf.build/protocolbuffers/go/roadrunner-server/api
go get github.com/roadrunner-server/api/build/<API_NAME>/v1
```

The Proto API is used for external integrations, mostly for RPC or as internal communications. For example:
```go
package foo

import (
jobsv1 "go.buf.build/protocolbuffers/go/roadrunner-server/api"
jobsv1 "github.com/roadrunner-server/api/build/jobs/v1"
)

func Push(in *jobsv1.PushRequest, out *jobsv1.Empty) error {
return nil
}
```

- You can also navigate to the [`DOCS`](https://buf.build/roadrunner-server/api/docs) tab to inspect the full API.

# Building API

- Install buf: `go install github.com/bufbuild/buf/cmd/buf@latest`.
- In the repository root run: `buf generate --debug`

0 comments on commit e7681ac

Please sign in to comment.