From 21ead5785fcd48dad001499a14a895e397984b0b Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Fri, 2 Aug 2019 16:28:11 +0200 Subject: [PATCH] docs: async migration --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6a484d9ffd..e26609967b 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,8 @@ npm install --save libp2p ## Usage +**IMPORTANT NOTE**: We are currently on the way of migrating all our `libp2p` modules to use `async await` and `async iterators`, instead of callbacks and `pull-streams`. As a consequence, when you start a new libp2p project, we must check which versions of the modules you should use. For now, it is required to use the modules using callbacks with `libp2p`, while we are working on getting the remaining modules ready for a full migration. For more details, you can have a look at [libp2p/js-libp2p#266](https://github.com/libp2p/js-libp2p/issues/266). + ### [Tutorials and Examples](/examples) You can find multiple examples on the [examples folder](/examples) that will guide you through using libp2p for several scenarios.