From 5ffe0d5b70fae106583efd8e5209799f25c47b6d Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Thu, 4 May 2023 15:01:05 +0100 Subject: [PATCH] add use cases page --- docs/overview/history.md | 2 +- docs/overview/implementations.md | 8 ++++---- docs/overview/use-cases.md | 14 ++++++++++++++ docs/overview/why-waku.md | 10 +++++----- sidebars.js | 1 + 5 files changed, 25 insertions(+), 10 deletions(-) create mode 100644 docs/overview/use-cases.md diff --git a/docs/overview/history.md b/docs/overview/history.md index fd61b4b..a98450a 100644 --- a/docs/overview/history.md +++ b/docs/overview/history.md @@ -1,5 +1,5 @@ --- -title: History of Waku +title: The Story of Waku --- Waku v1 was a fork of Whisper with some added tweaks for efficiency. Waku v2 is a completely redesigned suite of protocols designed to address the goals set out [previously](/#motivation-and-goals). diff --git a/docs/overview/implementations.md b/docs/overview/implementations.md index d1ceac9..d25bcae 100644 --- a/docs/overview/implementations.md +++ b/docs/overview/implementations.md @@ -2,9 +2,9 @@ title: Waku Implementations --- -Waku has been implemented in multiple languages to cater to a variety of unique use-cases: +Waku has been implemented in multiple programming languages to address various use cases. The Waku development team builds and maintains each implementation, ensuring that updates are provided automatically. -### [nwaku](https://github.com/status-im/nwaku) +### [nwaku](https://github.com/waku-org/nwaku) The Nim implementation of the Waku protocol is the reference implementation recommended for deploying a node in the cloud or at home. @@ -12,10 +12,10 @@ The Nim implementation of the Waku protocol is the reference implementation reco The JavaScript/TypeScript implementation of the Waku protocol designed for use in browser environments. -### [go-waku](https://github.com/status-im/go-waku) +### [go-waku](https://github.com/waku-org/go-waku) The Golang implementation of the Waku protocol designed for native integration in Golang applications, includes C bindings with examples available in C#, Swift, and Kotlin. ### [@waku/react-native](https://github.com/waku-org/waku-react-native) -Use [go-waku](https://github.com/status-im/go-waku) for mobile to integrate Waku into your React Native application. +Use [go-waku](https://github.com/waku-org/go-waku) for mobile to integrate Waku into your React Native application. diff --git a/docs/overview/use-cases.md b/docs/overview/use-cases.md new file mode 100644 index 0000000..af0d96a --- /dev/null +++ b/docs/overview/use-cases.md @@ -0,0 +1,14 @@ +--- +title: Waku Use Cases +--- + +Here are some of the use cases that Waku enables to operate securely and privately without the need for a central authority to manage communication: + +1. Dapp to Wallet Communication +2. NFT Marketplace +3. Generalized Marketplace +4. State Channels +5. Game Mechanics Communication +6. Layer 2 Coordination (Open Market, Spam Protected Mempool) +7. Signature Exchange for Multi-Signature Wallets +8. Chat Messenger: Status Communities \ No newline at end of file diff --git a/docs/overview/why-waku.md b/docs/overview/why-waku.md index a166832..1f3eed4 100644 --- a/docs/overview/why-waku.md +++ b/docs/overview/why-waku.md @@ -18,12 +18,12 @@ Waku is intended to empower individuals by returning control of communication to - It can run on various platforms, including mobile devices, cloud environments, web browsers, native desktop apps, or even dappnodes! -## Whisper vs. Waku +## Whisper vs. Waku: Why Waku Wins | | Whisper | Waku | | - | - | - | | **Scalability** | Whisper doesn't scale very well, specifically when it comes to bandwidth usage on mobile devices. | Uses sharding to partition the network into separate gossipsub networks, while maintaining a shared discovery network for peer location. | -| **Spam Resistance** | Proof of work requires too much battery and compute power making it a poor mechanism for heterogeneous nodes. | Uses innovative p2p economic spam protection mechanism RLN Relay | -| **Incentivization Infrastructure** | There is no incentive to run a Whisper node | Research in progress to design incentivization for node operators. | -| **Formal Specification/Documentation** | Lack of formal and unambiguous specification | The specs and docs are open-source and licensed under CC0, making them freely available for anyone to read, modify and improve without restrictions. | -| **Portability** | Runs over devp2p which limits where Whisper can run and how | Waku is built using libp2p, making it easy to run Waku anywhere. | +| **Spam Resistance** | Proof of work requires too much battery and compute power making it a poor mechanism for heterogeneous nodes. | Uses innovative p2p economic spam protection mechanism RLN Relay. | +| **Incentivization Infrastructure** | There is no incentive to run a Whisper node. | Research in progress to design incentivization for node operators. | +| **Formal Specification/Documentation** | Lack of formal and unambiguous specification. | The specs and docs are open-source and licensed under CC0, making them freely available for anyone to read, modify and improve without restrictions. | +| **Portability** | Runs over devp2p which limits where Whisper can run and how. | Waku is built using libp2p, making it easy to run Waku anywhere. | diff --git a/sidebars.js b/sidebars.js index 3b7d04d..30b00d8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -7,6 +7,7 @@ const sidebars = { "overview/what-is-waku", "overview/history", "overview/why-waku", + "overview/use-cases", "overview/who-is-using-waku", "overview/implementations", {