rfc/README.md

# Specifications

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).

## Status

The entire vac protocol is under active development, each specification has its own `status` which is reflected through the version number at the top of every document. We use [semver](https://semver.org/) to version these specifications.

## Protocols

These protocols define various components of the [vac](https://vac.dev) stack.

 - [mvds](./mvds.md) - Ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive.

 - [remote log](./remote-log.md) - Ensures a node can read data from a node that is offline by replicating a local log remotely.


## Style guide
<!-- @Todo put this in a better place !-->
All specs follow [RFC-2119](https://tools.ietf.org/html/rfc2119).

Sequence diagrams are generated using [Mscgen](http://www.mcternan.me.uk/mscgen/) like this: `mscgen -T png -i input.msc -o output.png`. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.
Update README.md 2019-08-02 17:27:59 +02:00			`# Specifications`
Update README.md 2019-07-25 20:32:54 +02:00
vacp2p -> vac 2019-08-02 18:18:06 +02:00			`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).`
Update README.md 2019-07-25 20:32:54 +02:00
			`## Status`

vacp2p -> vac 2019-08-02 18:18:06 +02:00			The entire vac protocol is under active development, each specification has its own `status` which is reflected through the version number at the top of every document. We use [semver](https://semver.org/) to version these specifications.
adding some stuff to readme 2019-08-02 17:01:36 +02:00
Update README.md 2019-07-25 20:32:54 +02:00			`## Protocols`

vacp2p -> vac 2019-08-02 18:18:06 +02:00			`These protocols define various components of the [vac](https://vac.dev) stack.`
Update README.md 2019-07-25 20:32:54 +02:00
			`- [mvds](./mvds.md) - Ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive.`
Add style guide on sequence diagrams 2019-09-24 13:29:48 +08:00
Update README.md 2019-10-03 05:14:49 +02:00			`- [remote log](./remote-log.md) - Ensures a node can read data from a node that is offline by replicating a local log remotely.`
update readme remote log 2019-10-03 11:08:30 +08:00

Add style guide on sequence diagrams 2019-09-24 13:29:48 +08:00			`## Style guide`
Update README.md 2019-07-25 20:36:01 +02:00			`<!-- @Todo put this in a better place !-->`
			`All specs follow [RFC-2119](https://tools.ietf.org/html/rfc2119).`
Add style guide on sequence diagrams 2019-09-24 13:29:48 +08:00
			Sequence diagrams are generated using [Mscgen](http://www.mcternan.me.uk/mscgen/) like this: `mscgen -T png -i input.msc -o output.png`. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.