From 02f029a54d0f5c6bcb07ca231d6bf29cd4612a18 Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Fri, 25 Aug 2023 13:57:35 +0700 Subject: [PATCH] add deprecation notice to README (#125) * add deprecation notice to README * Update README.md Co-authored-by: Prithvi Shahi --------- Co-authored-by: Prithvi Shahi --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26e47f3..afc1a9e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# 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. + +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) [![Go Reference](https://pkg.go.dev/badge/github.com/libp2p/go-mplex.svg)](https://pkg.go.dev/github.com/libp2p/go-mplex)