mirror of
https://github.com/status-im/status-go.git
synced 2025-01-09 22:26:30 +00:00
Samuel Hawksby-Robinson
77d9d0f4c9
Waku package README.md documentation (#1949)
* Added waku README.md, starting text and structure Resolves GH-1944 * Added api, config and doc details * Created Docs for waku.const, envelope and events * Added notes on Filter * Rewrote the filter section * Restructured docs to match new versioning structure * Moved package files out of the main ToC * Added waku/common/README.md * Added details to mailserver.go and notes to api.go * Update to bloomfilter and const common * Added common/ helpers.go, errors.go and message.go details * Added common/metrics.go and protocol details * Added rate_limiter and topic.go details * fix rate limiter table * Added Waku Versioning details * Added Versioned sub-package file details * Added better detail for Waku Filters Addressing https://github.com/status-im/status-go/pull/1949#discussion_r419232235 * Added notes about light nodes not being actually new * Added more detail for Waku node configs and defaults * Added details to the version message.go section * Added details to waku/common/rate_limiter * Minor typo fix in docs
Status bindings for go-ethereum
Docs
- How to Build
- How to Contribute
- How to Release
- How to run a Bootnode
- How to run a Mailserver
- How to run a Waku node
- How to configure status-go
License
Description
Languages
Go
98.6%
Python
0.7%
Shell
0.4%
Makefile
0.1%
Groovy
0.1%