From d0eec315652556d879a207fe180d93398808675e Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Tue, 31 May 2022 08:14:21 -0700 Subject: [PATCH] chore: minor migration guide fixes --- docs/upgrading/v0.62-v0.63.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/upgrading/v0.62-v0.63.md b/docs/upgrading/v0.62-v0.63.md index 731e953f91..e931a9aa49 100644 --- a/docs/upgrading/v0.62-v0.63.md +++ b/docs/upgrading/v0.62-v0.63.md @@ -14,7 +14,7 @@ The biggest change to `ipfs@0.63.x` is that the module is now [ESM-only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). -ESM is the module system for JavaScript, it allows us to structure our code in separate files without polluting a global namespace. +ESM is the module system for JavaScript. It allows us to structure our code in separate files without polluting a global namespace. Other systems have tried to fill this gap, notably CommonJS, AMD, RequireJS and others, but ESM is [the official standard format](https://tc39.es/ecma262/#sec-modules) to package JavaScript code for reuse. @@ -34,11 +34,11 @@ async function loadIpfs () { } ``` -## libp2p@0.37.x +## `libp2p@0.37.x` `ipfs@0.63.x` upgrades to `libp2p@0.37.x`. This is a significant refactor that ports the entire stack to TypeScript and publishes all modules as ESM-only code. -Please see the [libp2p 0.37.x` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.36-v.037.md) for how this may affect your application. +Please see the [libp2p 0.37.x upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.36-v.037.md) for how this may affect your application. ## PeerIds @@ -116,7 +116,7 @@ const peerId = await createEd25519PeerId() ## multiaddrs -The `multiaddr` module has been ported to Typescript and is now published as ESM-only. +The `multiaddr` module has been ported to TypeScript and is now published as ESM-only. It has been renamed to `@multiformats/multiaddr` so please update your dependencies and replace usage in your code.