Skip to content

Commit

Permalink
Update README.md (#151)
Browse files Browse the repository at this point in the history
Move the logo out of the heading to be consistent with other
repositories that have a logo (e.g. https://github.com/bufbuild/buf,
https://github.com/connectrpc/connect-es), and update the README to be
consistent with the language used in [PGV
readme](https://github.com/bufbuild/protoc-gen-validate/blob/main/README.md)
(see also bufbuild/protoc-gen-validate#1012)
  • Loading branch information
nicksnyder authored Jan 2, 2024
1 parent 44761c4 commit d03eed0
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
# [![](.github/buf-logo.svg)][buf] protovalidate
![The Buf logo](./.github/buf-logo.svg)

# protovalidate

[![CI](https://github.com/bufbuild/protovalidate/actions/workflows/ci.yaml/badge.svg?branch=main)][ci]
[![Slack](https://img.shields.io/badge/Slack-Buf-%23e01563)][slack]
[![BSR](https://img.shields.io/badge/BSR-Module-0C65EC)][buf-mod]

**_Update: The next generation of `protoc-gen-validate`, now called
`protovalidate`, is available in beta for Golang, Python, Java, and C++!
We're hard at work on a TypeScript implementations as well. To learn more, check out
our [blog post][announce]. We value your input in refining our products, so
don't hesitate to share your feedback on `protovalidate`._**

`protovalidate` is a series of libraries designed to validate Protobuf messages at
runtime based on user-defined validation rules. Powered by Google's Common
Expression Language ([CEL][cel-spec]), it provides a
flexible and efficient foundation for defining and evaluating custom validation
rules. The primary goal of `protovalidate` is to help developers ensure data
consistency and integrity across the network without requiring generated code.

> `protovalidate` is the spiritual successor to `protoc-gen-validate`. Looking
for `protoc-gen-validate`? Checkout the original [repository][pgv].
> [!NOTE]
> `protovalidate` is the spiritual successor to [protoc-gen-validate][pgv].
>
> We recommend that new and existing projects transition to using `protovalidate` instead of `protoc-gen-validate`.
>
> Read [our blog post][announce] if you want to learn more about the limitations of `protoc-gen-validate` and
> how we have designed `protovalidate` to be better.
## What is this repository?

Expand Down

0 comments on commit d03eed0

Please sign in to comment.