From 27dd3ff1054ee496b8e5967c11ba7c51e670216a Mon Sep 17 00:00:00 2001 From: Slavo Vojacek Date: Sat, 6 Apr 2024 15:40:54 +0100 Subject: [PATCH] Update readme --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index af979d0..443b1a7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -Install Buf CLI: +# Thames APIs + +Protobuf definitions for Thames public APIs, following [API Design Patterns](https://www.oreilly.com/library/view/api-design-patterns/9781617295850/). + +## Contributing + +Install [Buf CLI](https://buf.build/product/cli): ```sh brew install buf @@ -11,9 +17,8 @@ proto> buf lint proto> buf format -w ``` -Useful reading: +### Useful reading -- https://buf.build/product/cli - https://github.com/connectrpc/connect-es - https://buf.build/blog/connect-node-beta - https://connectrpc.com/docs/web/using-clients/