This repository has been archived by the owner on Jun 26, 2023. It is now read-only.

transport upgrader docs #56

Closed

vasco-santos opened this issue Jul 20, 2020 · 1 comment

Labels

help wanted status/ready topic/docs

Member

vasco-santos commented Jul 20, 2020 •

edited

Loading

The transport upgrader created some confusion and we should improve its documentation here: https://github.com/libp2p/js-libp2p-interfaces/tree/master/src/transport#upgrader

We currently mention what the upgrader function includes, but we do not mention what is its goal and need.

Ref:

what is an upgrader? js-libp2p-webrtc-star#218

vasco-santos added topic/docs help wanted status/ready labels

Member

achingbrain commented Jun 26, 2023

Closing due to staleness. There is an interface for the upgrader, DX improvements can be made by documenting the interface methods.

achingbrain closed this as completed

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.