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
This is a NodeJs wrapper around Waku
4 Commits 1 Branch 0 Tags 38 KiB
C 83.5%
JavaScript 11.7%
TypeScript 4.1%
Python 0.7%
Go to file
Ivan Folgueira Bande 12a31380a7
package.json: fix README.md name on distributed package 		2024-01-13 13:32:51 +01:00
src Add src/examples/simple/README.md 2024-01-13 13:32:24 +01:00
.gitignore First commit 2024-01-13 13:14:57 +01:00
.gitmodules First commit 2024-01-13 13:14:57 +01:00
.npmignore First commit 2024-01-13 13:14:57 +01:00
README.md README.md more info 2024-01-13 13:20:59 +01:00
package.json package.json: fix README.md name on distributed package 2024-01-13 13:32:51 +01:00

README.md

Intro

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.

Create a package

  1. Run npm run prepare-package
  2. Run npm run build-libwaku (step required to build the libwaku.so library)
  3. Run npm run build-gyp
  4. Run npm run build-package

Publish a package

Run npm run publish-package

ℹ️ See the package.json file for details about npm commands definitions.