Skip to content

Update README to fix a few issues #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pkwarren merged 2 commits into from
Sep 12, 2026
Merged

Update README to fix a few issues #341

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c628b4
Update README to fix a few issues
pkwarren Sep 11, 2026
dbe7d5e
Also remove report card badge
pkwarren Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

[![CI](https://github.com/bufbuild/protovalidate-go/actions/workflows/ci.yaml/badge.svg)](https://github.com/bufbuild/protovalidate-go/actions/workflows/ci.yaml)
[![Conformance](https://github.com/bufbuild/protovalidate-go/actions/workflows/conformance.yaml/badge.svg)](https://github.com/bufbuild/protovalidate-go/actions/workflows/conformance.yaml)
[![Report Card](https://goreportcard.com/badge/buf.build/go/protovalidate)](https://goreportcard.com/report/buf.build/go/protovalidate)
[![GoDoc](https://pkg.go.dev/badge/buf.build/go/protovalidate.svg)](https://pkg.go.dev/buf.build/go/protovalidate)
[![BSR](https://img.shields.io/badge/BSR-Module-0C65EC)][buf-mod]

Expand Down Expand Up @@ -37,15 +36,16 @@ message User {
Once you've added `protovalidate-go` to your project, validation is idiomatic Go:

```go
if err = protovalidate.Validate(moneyTransfer); err != nil {

@pkwarren pkwarren Sep 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😕

user := &userv1.User{ /* ... */ }
if err := protovalidate.Validate(user); err != nil {
// Handle failure.
}
```

## Installation

> [!TIP]
> The easiest way to get started with Protovalidate for RPC APIs are the quickstarts in Buf's documentation. They're available for both [Connect][connect-go] and [gRPC][grpc-go].
> The easiest ways to get started with Protovalidate for RPC APIs are the quickstarts in Buf's documentation. They're available for both [Connect][connect-go] and [gRPC][grpc-go].

To install the package, use `go get` from within your Go module:

Expand All @@ -55,7 +55,7 @@ go get buf.build/go/protovalidate

## Documentation

Comprehensive documentation for Protovalidate is available at [protovalidate.com][protovalidate].
Comprehensive documentation for Protovalidate is available at [protovalidate.com][protovalidate].

Highlights for Go developers include:

Expand All @@ -66,17 +66,17 @@ Highlights for Go developers include:
API documentation for Go is available on [pkg.go.dev][pkg-go].

### Native standard validation rules
protovalidate-go provides native support for standard validation rule processing. They are enabled by default and are disabled by setting the ValidatorOption `WithDisableNativeRules`.

We continue to validate that the native rules and the CEL rules produce identical results. The `compliance` Makefile target has been updated to run twice,
once with the native rules enabled, and once with the CEL rules enabled.
Standard validation rules are evaluated by native Go implementations where available, falling back to CEL. This is enabled by default - pass the `WithDisableNativeRules` validator option to evaluate all standard rules through CEL instead.

The `conformance` Makefile target runs the conformance suite twice, once with native rules enabled and once with them disabled, to verify both paths produce identical results.

## Additional languages and repositories

Protovalidate isn't just for Go! You might be interested in sibling repositories for other languages:
Protovalidate isn't just for Go! You might be interested in sibling repositories for other languages:

- [`protovalidate-java`][pv-java] (Java)
- [`protovalidate-python`][pv-python] (Python)
- [`protovalidate-py`][pv-py] (Python)
- [`protovalidate-cc`][pv-cc] (C++)
- [`protovalidate-es`][pv-es] (TypeScript and JavaScript)

Expand All @@ -100,9 +100,8 @@ Offered under the [Apache 2 license][license].
[buf]: https://buf.build
[cel]: https://cel.dev

[pv-go]: https://github.com/bufbuild/protovalidate-go
[pv-java]: https://github.com/bufbuild/protovalidate-java
[pv-python]: https://github.com/bufbuild/protovalidate-python
[pv-py]: https://github.com/bufbuild/protovalidate-py
[pv-cc]: https://github.com/bufbuild/protovalidate-cc
[pv-es]: https://github.com/bufbuild/protovalidate-es

Expand All @@ -116,13 +115,9 @@ Offered under the [Apache 2 license][license].
[quickstart]: https://protovalidate.com/quickstart/
[connect-go]: https://protovalidate.com/quickstart/connect-go/
[grpc-go]: https://protovalidate.com/quickstart/grpc-go/
[grpc-java]: https://protovalidate.com/quickstart/grpc-java/
[grpc-python]: https://protovalidate.com/quickstart/grpc-python/
[migration-guide]: https://protovalidate.com/migration-guides/migrate-from-protoc-gen-validate/
[conformance-executable]: ./internal/cmd/protovalidate-conformance-go/README.md
[pkg-go]: https://pkg.go.dev/buf.build/go/protovalidate

[validate-proto]: https://buf.build/bufbuild/protovalidate/docs/main:buf.validate
[conformance]: https://github.com/bufbuild/protovalidate/blob/main/docs/conformance.md
[examples]: https://github.com/bufbuild/protovalidate/tree/main/examples
[migrate]: https://protovalidate.com/migration-guides/migrate-from-protoc-gen-validate/
Loading