From 34bad788b5ebb37cedd046b8fabe2c0b7f054a6d Mon Sep 17 00:00:00 2001 From: Max Inden Date: Thu, 22 Sep 2022 16:34:53 +0100 Subject: [PATCH 1/2] README.md: Mark `ls` as optional go-multistream removed `ls` support in https://github.com/multiformats/go-multistream/pull/76. This breaks compatibility with the multistream implementation in Rust see https://github.com/libp2p/rust-libp2p/issues/2925. This commit updates the specification after the fact, explicitly making `ls` support optional. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1a5b51a..a1c65aa 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,8 @@ For example < ... ``` +Note that `ls` support is OPTIONAL, i.e. implementations MAY support sending and/or receiving `ls`. This in turn implies that implementations MUST NOT depend on a remote node supporting `ls`. + #### Implementation Recommendations **Protocol Selection** From 94f37eaabd1f006ad7073a226ce23d6ff6327454 Mon Sep 17 00:00:00 2001 From: Max Inden Date: Tue, 27 Sep 2022 16:49:33 +0100 Subject: [PATCH 2/2] README: Reword beginning of ls section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a1c65aa..83e440c 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ for example: #### Listing -It is also possible to "list" the available protocols. A list message is simply: +Implementations MAY support "listing" of the available protocols. A list message is simply: ``` ls\n