From f9fb73a7d8c2221ca4b6fc994f730a063e0ccf1e Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Thu, 17 Aug 2023 02:21:17 -0700 Subject: [PATCH 1/2] add deprecation notice to README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26e47f3..d4215d1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# go-mplex +# DEPRECATED: go-mplex + +mplex is deprecated. When on TCP, we recommend using [Yamux](https://github.com/libp2p/go-yamux/) instead. +If TCP is not a requirement, consider using QUIC instead. + +--- [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai) [![Go Reference](https://pkg.go.dev/badge/github.com/libp2p/go-mplex.svg)](https://pkg.go.dev/github.com/libp2p/go-mplex) From b6dad039b8ac0ed8bee0a9a69411ba2d490c56ca Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Thu, 24 Aug 2023 22:58:49 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Prithvi Shahi --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d4215d1..afc1a9e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ mplex is deprecated. When on TCP, we recommend using [Yamux](https://github.com/libp2p/go-yamux/) instead. If TCP is not a requirement, consider using QUIC instead. +Ref: Discussion around mplex deprecation: https://github.com/libp2p/specs/issues/553 + --- [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)