Skip to content

Commit 02f029a

Browse files
add deprecation notice to README (#125)
* add deprecation notice to README * Update README.md Co-authored-by: Prithvi Shahi <[email protected]> --------- Co-authored-by: Prithvi Shahi <[email protected]>
1 parent a97688f commit 02f029a

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# go-mplex
1+
# DEPRECATED: go-mplex
2+
3+
mplex is deprecated. When on TCP, we recommend using [Yamux](https://github.com/libp2p/go-yamux/) instead.
4+
If TCP is not a requirement, consider using QUIC instead.
5+
6+
Ref: Discussion around mplex deprecation: https://github.com/libp2p/specs/issues/553
7+
8+
---
29

310
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
411
[![Go Reference](https://pkg.go.dev/badge/github.com/libp2p/go-mplex.svg)](https://pkg.go.dev/github.com/libp2p/go-mplex)

0 commit comments

Comments
 (0)