From 1e5e3dde9348568d4352c5786701545e80106cc7 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 27 Mar 2023 14:15:17 +1100 Subject: [PATCH] Add intro for js-waku --- docs/browser/introduction.mdx | 36 ++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/browser/introduction.mdx b/docs/browser/introduction.mdx index 2b15ebb..8d7ea6e 100644 --- a/docs/browser/introduction.mdx +++ b/docs/browser/introduction.mdx @@ -2,4 +2,38 @@ title: Introduction --- -js-waku doc goes here +# JS-Waku Documentation + +[JS-Waku](https://github.com/waku-org/js-waku) is the TypeScript implementation of the Waku protocol, +specifically designed for the browser environment. +This powerful, easy-to-use library enables you to integrate Waku into your web applications seamlessly. + +:::info + +If you wish to use Waku with a NodeJS application, you can either: +- Use [nwaku](https://github.com/status-im/nwaku)'s [JSON RPC API](https://rfc.vac.dev/spec/16/) +- Or, attempt to use go-waku's [c-bindings](https://github.com/waku-org/go-waku/tree/master/examples/c-bindings) in NodeJS + +::: + +To get started, the [Quick Start](./quick-start) guide offers a simple way to integrate Waku into your web app. +For a more comprehensive tutorial, follow the [Build a Chat App](./build-chat-app) guide, +which demonstrates how to create a chat app from scratch. + +Explore the [js-waku-examples repository](https://github.com/waku-org/js-waku-examples) to find various working Proof-of-Concepts that showcase how to use JS-Waku effectively. +You can also interact with these examples live: + +- [web-chat](https://examples.waku.org/web-chat): A simple public chat. +- [eth-pm](https://examples.waku.org/eth-pm): End-to-end encrypted private messages. +- [rln-js](https://examples.waku.org/rln-js): Demonstration of [RLN](https://rfc.vac.dev/spec/32/), +an economic spam protection protocol that rate limit using zero-knowledge for privacy preserving purposes. + +To gain a deeper understanding of Waku, visit the [overview documentation](/). +If you're interested in learning how Waku works under the hood, check out the specs at [rfc.vac.dev](https://rfc.vac.dev/). + +## Bugs, Questions & Support + +If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/). + +For general discussion, get help or latest news, +join **#js-waku** on [Vac Discord](https://discord.gg/Nrac59MfSX) or the [Waku Telegram Group](https://t.me/waku_org).