Skip to content

Commit

Permalink
add deprecation notice to README (#125)
Browse files Browse the repository at this point in the history
* add deprecation notice to README

* Update README.md

Co-authored-by: Prithvi Shahi <shahi.prithvi@gmail.com>

---------

Co-authored-by: Prithvi Shahi <shahi.prithvi@gmail.com>
  • Loading branch information
marten-seemann and p-shahi authored Aug 25, 2023
1 parent a97688f commit 02f029a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down

0 comments on commit 02f029a

Please sign in to comment.