From a920e7aa6da7605f8991a2ff6836b0ce573d2e44 Mon Sep 17 00:00:00 2001 From: Marco Munizaga Date: Fri, 20 Jan 2023 17:11:25 -0800 Subject: [PATCH] Update README to recommend proto3 --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64764ef..68dfa8c 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,14 @@ and are used throughout the system. These specs define wire protocols that are used by libp2p for connectivity, security, multiplexing, and other purposes. -The protocols described below all use [protocol buffers](https://developers.google.com/protocol-buffers/docs/proto?hl=en) (aka protobuf) to define message schemas. Version `proto2` is used unless stated otherwise. +The protocols described below all use [protocol +buffers](https://developers.google.com/protocol-buffers/docs/proto?hl=en) (aka +protobuf) to define message schemas. + +Existing protocols may use `proto2`, and continue to use them. `proto3` is +recommended for new protocols. `proto3` is a simplification of `proto2` and +removes some footguns. For context and a discussion around `proto3` vs `proto2`, +see [#465](https://github.com/libp2p/specs/issues/465). - [ping][spec_ping] - Ping protocol - [autonat][spec_autonat] - NAT detection