From 9a8ecd8611ecf0803863e07df76f9d843f2fb84e Mon Sep 17 00:00:00 2001 From: Franck Royer Date: Tue, 12 Oct 2021 16:29:52 +1100 Subject: [PATCH] Update README to include unpkg example --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70506864b8..00c42e9fa8 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,42 @@ Install `js-waku` package: npm install js-waku ``` +### Import js-waku + +To use js-waku in your application, you can: + +use `import`: + +```js +import { Waku } from 'js-waku'; + +const waku = await Waku.create(); +``` + +use `require`: + +```js +const jsWaku = require('js-waku'); + +jsWaku.Waku.create().then(waku => { + // ... +}); +``` + +Or directly import it in a ` + +``` + ### Start a waku node ```ts -import { Waku } from 'js-waku'; - const waku = await Waku.create({ bootstrap: true }); ```