From 351ed8102ef07ab274047d404b0961564803f680 Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Sat, 13 Jan 2024 13:20:59 +0100 Subject: [PATCH] README.md more info --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ab9417e..528eda5 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ ## Intro -This is a NodeJs wrapper around Waku +NodeJs wrapper around Waku + +The Waku node binary is generated in a shape of a shared library, libwaku.so. This library is currently created from +the `nwaku` repository, a.k.a. "Nim Waku" (vendor dependency.) + +On the other hand, the `libwaku.so` library is wrapped to NodeJs +by means of the `node-gyp` utility. ## Requirements node-gyp is required to be installed in the system. -The following commands should be run to install npm dependencies: - -cd src && npm install bindings - ## Create a package 1. Run `npm run prepare-package`