waku-org/js.waku.guide
1
0
Fork 0
mirror of https://github.com/waku-org/js.waku.guide.git synced 2025-02-23 12:18:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
js.waku.guide/content/docs/introduction.md

51 lines
2.5 KiB
Markdown
Raw Normal View History

replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-12-09 15:27:58 +01:00
---
title: Introduction
date: 2021-12-09T14:00:00+01:00
Add videos (#24)
2022-01-12 14:41:29 +11:00
weight: 10
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-12-09 15:27:58 +01:00
---
Run prettier (#29)
2022-01-24 12:17:00 +11:00
js-waku docs are now hosted at a new location (#30)
2022-01-27 11:18:41 +11:00
# Waku Connect Docs
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
js-waku docs are now hosted at a new location (#30)
2022-01-27 11:18:41 +11:00
Waku Connect is a suite of libraries, SDKs and documentations to help you use Waku in your dApp.
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
Fix links, remove overview file, add light push (#2)
2021-12-01 15:44:28 +11:00
Waku is a decentralized, censorship-resistant, network and protocol family.
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
It enables you to add communication features to your dApp in a decentralized manner,
Fix links, remove overview file, add light push (#2)
2021-12-01 15:44:28 +11:00
ensuring to your users that they will not be censored or de-platformed.
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
Waku can be used for chat purposes and for many machine-to-machine use cases.
Replace waku.vac.dev with wakunetwork (#26)
2022-01-24 09:35:35 +11:00
You can learn more about Waku at [wakunetwork.com](https://wakunetwork.com).
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
JS-Waku is the TypeScript implementation of the Waku protocol,
built for browser environment.
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-12-09 15:27:58 +01:00
The [quick start](/docs/quick_start/) presents an easy way to send and receive messages using js-waku.
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
Add videos (#24)
2022-01-12 14:41:29 +11:00
If you prefer video content, check out the [presentations](/docs/presentations).
Add use cases page (#17)
2022-01-10 12:30:09 +11:00
If you are looking for inspiration, check out the [use cases](/docs/use_cases) Waku can enable.
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-12-09 15:27:58 +01:00
The [guides](/docs/guides) explain specific js-waku features
Fix links, remove overview file, add light push (#2)
2021-12-01 15:44:28 +11:00
and how it can be used with popular web frameworks.
The js-waku repository also holds a number of [examples](https://github.com/status-im/js-waku/tree/main/examples).
The examples are working Proof-of-Concepts that demonstrate how to use js-waku.
Run prettier (#29)
2022-01-24 12:17:00 +11:00
Check out the [example list](/docs/examples/) to see what usage each example demonstrates.
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
Examples are now hosted on wakuconnect.dev (#33)
2022-02-02 11:56:14 +11:00
You can also try out some of the examples at the following locations:
- [web-chat](https://js-waku.wakuconnect.dev/examples/web-chat): A simple public chat ([docs](/docs/examples/#web-chat-app)).
- [eth-pm](https://js-waku.wakuconnect.dev/examples/eth-pm): End-to-end encrypted private messages
([docs](/docs/examples/#ethereum-private-message-web-app)).
- [eth-pm-wallet-encryption](https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption): Eth-pm using Web3 wallet encryption API
- ([dosc](/docs/examples/#ethereum-private-message-using-web3-wallet-encryption-api-web-app)).
Import guides from js-waku (#1)
2021-11-30 12:50:16 +11:00
Finally, if you want to learn how Waku works under the hoods, check 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/status-im/js-waku/issues/new/).
js-waku docs are now hosted at a new location (#30)
2022-01-27 11:18:41 +11:00
To get help, join #wakuconnect-support on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or [Telegram](https://t.me/wakuconnectsupport).
For more general discussion and latest news, join #wakuconnect on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/wakuconnect).
Reference in New Issue Copy Permalink