You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The doc in the master branch consist of changed API also from the pre-release. This might be confusing for a dev to find the write documentation.
For eg: it took me some time to realise createLibp2p() is replaced with create() in the pre release. Using the latest release from the npm I would still use the createLibp2p() but the master doc says to use the create().
Possible Solution
In the readme add the following line
The doc linked in the master branch are for pre-release.
If you are looking for the docs for the latest release, then (head here)[link to npm docs]
Enhancement
Severity:
Low
Description:
The doc in the master branch consist of changed API also from the pre-release. This might be confusing for a dev to find the write documentation.
For eg: it took me some time to realise
createLibp2p()
is replaced withcreate()
in the pre release. Using the latest release from the npm I would still use thecreateLibp2p()
but the master doc says to use thecreate()
.Possible Solution
In the readme add the following line
Thanks @vasa-develop
The text was updated successfully, but these errors were encountered: