README.md

Play gRPC

Play support for akka-grpc and pekko-grpc.

Project Status

This library is ready to be used in production, but APIs are still expected to be improved and may change.

Compatibility & support

This project does not yet have to obey the rule of staying binary compatible between releases that is common for libraries under the Play Framework organization. Breaking API changes may be introduced without notice as we refine and simplify based on your feedback.

Docs

For testing documentation locally use a few next commands (for more details see Antora workflow):

cd docs
npm i -D -E @antora/cli @antora/site-generator @antora/lunr-extension @asciidoctor/tabs
npx antora local-antora-playbook.yml

Then open in browser generated documentation from <repo_path>/docs/build/site.

Releasing a new version

See https://github.com/playframework/.github/blob/main/RELEASING.md