waku-org
/
waku-nodejs-bindings
mirror of https://github.com/waku-org/waku-nodejs-bindings.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README.md more info

This commit is contained in:
Ivan Folgueira Bande 2024-01-13 13:20:59 +01:00
parent 908ff85e75
commit 351ed8102e
No known key found for this signature in database
GPG Key ID: 3C117481F89E24A7
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,16 +1,18 @@
## Intro ## 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 ## Requirements
node-gyp is required to be installed in the system. 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 ## Create a package
1. Run `npm run prepare-package` 1. Run `npm run prepare-package`