vacp2p/rfc
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc.git synced 2025-02-23 12:18:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve README (#289)

Browse Source 
* Improve README

* Fix more links

* Add rln relay, swap and v2 rpc api; fix links

* Update README.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>
This commit is contained in:
Oskar Thorén 2021-02-18 12:11:51 +08:00 committed by GitHub
parent b6a965ca70
commit 5da4474fe4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,4 +1,4 @@
![CI](https://github.com/vacp2p/specs/workflows/CI/badge.svg) <!-- [CI](https://github.com/vacp2p/specs/workflows/CI/badge.svg) -->
This repository contains the specs for [vac](https://vac.dev), a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found [here](https://vac.dev/vac-overview). This repository contains the specs for [vac](https://vac.dev), a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found [here](https://vac.dev/vac-overview).
@ -10,11 +10,27 @@ The entire vac protocol is under active development, each specification has its
These protocols define various components of the [vac](https://vac.dev) stack. These protocols define various components of the [vac](https://vac.dev) stack.
## Waku ### Waku
Waku is a protocol that substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627). Waku v2 is in development. Here you can read more about the [plan for it](https://vac.dev/waku-v2-plan) and an [update](https://vac.dev/waku-v2-update). Waku is a protocol that replaces Whisper ([EIP-627](https://eips.ethereum.org/EIPS/eip-627)). Waku v2 is an upgrade of Waku v1 that is in active development and offer significant improvements. You can read more about the [plan for it](https://vac.dev/waku-v2-plan) and an [update](https://vac.dev/waku-v2-update).
Waku is made up of several protocols and specifications. To see them go to the [Waku spec home](https://specs.vac.dev/specs/waku/). #### Version 2
- [waku/2](./waku/v2/waku-v2.md) specs for `waku/2` version, current draft version
- [waku/2 relay](./waku/v2/waku-relay.md) spec for WakuRelay, current draft version
- [waku/2 filter](./waku/v2/waku-filter.md) spec for WakuFilter, current draft version
- [waku/2 store](./waku/v2/waku-store.md) spec for WakuStore, current draft version
- [waku/2 message](./waku/v2/waku-message.md) spec for Waku Message, current draft version
- [waku/2 bridge](./waku/v2/waku-bridge.md) spec for Waku bridge with v1, alpha
- [waku/2 rln relay](./waku/v2/waku-rln-relay.md) spec for Waku Relay with RLN, alpha
- [waku/2 swap](./waku/v2/waku-swap-accounting.md) spec for Waku Swap Accounting, alpha
- [waku/2 rpc api](./waku/v2/waku-rpc-api.md) - Waku RPC API for Waku v2 nodes, alpha
#### Version 0 and 1
- [waku/0](./waku/v1/waku-0.md) specs for `waku/0` version, now deprecated
- [waku/1](./waku/v1/waku-1.md) specs for `waku/1` version, current stable version
- [envelope data format](./waku/v1/envelope-data-format.md) [waku](./waku/waku.md) envelope data field specification.
- [mailserver](./waku/v1/mailserver.md) - Mailserver specification for archiving and delivering historical [waku](./waku/waku.md) envelopes on demand.
- [rpc api](./waku/v1/waku-rpc-api.md) - Waku RPC API for Waku v1 nodes.
### Data sync ### Data sync