mirror of https://github.com/status-im/js-waku.git
199f6ab2ff
* initialise the new package * feat: implement LocalStorageDiscovery * add: Startable to cspell * add compliance test * add: discovery tests * rm: browser tests script * address comments * add type safety to getting peers from local * only dispatch peer if it does not exist * move ws ma extraction to utils * chore: update package name to local-discovery * fix: add compliance test with no external deps on service node * use peer:identify instead of peer:update * add: unit tests & remove sdk dependency * move tests to self package * update cspell + remove unrequired deps * add types * maintain in-memory peers for localstorage * address comments * chore: rename * use name from options * fix: saving peers * rm: only |
||
|---|---|---|
| .. | ||
| src | ||
| .eslintrc.cjs | ||
| .mocha.reporters.json | ||
| .mocharc.cjs | ||
| CHANGELOG.md | ||
| README.md | ||
| karma.conf.cjs | ||
| package.json | ||
| rollup.config.js | ||
| tsconfig.dev.json | ||
| tsconfig.json | ||
| typedoc.json | ||
README.md
@waku/core
Core components of js-waku, a TypeScript implementation of the Waku v2 protocol.
Documentation
API Documentation can also be generated locally:
git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
Changelog
Release changelog can be found in CHANGELOG.md.
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
For general discussion, get help or latest news, join #js-waku on Vac Discord or the Waku Telegram Group.
Roadmap
You can track progress on the project board.
Contributing
See CONTRIBUTING.md.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (LICENSE-APACHE-v2 or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.