status-go/waku/common
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
2020-05-14 08:49:06 +01:00
..
README.md Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
bloomfilter.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
const.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
envelope.go Refactor/waku tidy 1 (#1958) 2020-05-01 19:14:01 +01:00
envelope_test.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
errors.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
events.go Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
filter.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
filter_test.go Refactor/waku tidy (#1957) 2020-04-30 13:52:48 +01:00
helpers.go Refactor/waku tidy 1 (#1958) 2020-05-01 19:14:01 +01:00
message.go Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
message_test.go Refactor/waku tidy (#1957) 2020-04-30 13:52:48 +01:00
metrics.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
protocol.go Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
rate_limiter.go Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
rate_limiter_test.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00
topic.go Waku package README.md documentation (#1949) 2020-05-14 08:49:06 +01:00
topic_test.go Move networking code for waku under `v0` namespace 2020-04-27 14:58:02 +02:00

README.md

Waku Common

See here