Use gfm alerts in documentation
This commit is contained in:
parent
b0d7b60470
commit
98577b7ae6
2 changed files with 3 additions and 3 deletions
|
@ -1,6 +1,6 @@
|
||||||
# argh net
|
# argh net
|
||||||
|
|
||||||
> **WARNING**
|
> [!WARNING]
|
||||||
> This project is in an **EXPERIMENTAL** stage where things change all the time. Do not use (yet).
|
> This project is in an **EXPERIMENTAL** stage where things change all the time. Do not use (yet).
|
||||||
|
|
||||||
This project aims to develop a specification and software suite for the easy creation of distributed networks on top of websockets, specifically for **broadcasting** text messages.
|
This project aims to develop a specification and software suite for the easy creation of distributed networks on top of websockets, specifically for **broadcasting** text messages.
|
||||||
|
@ -9,5 +9,5 @@ The goal of this implementation is not to be very efficient or sophisticated, bu
|
||||||
|
|
||||||
See [SPEC.md](./SPEC.md) for the specification.
|
See [SPEC.md](./SPEC.md) for the specification.
|
||||||
|
|
||||||
> **NOTE**
|
> [!IMPORTANT]
|
||||||
> The specification and implementation are not always updated at the same time and may therefore be out of sync.
|
> The specification and implementation are not always updated at the same time and may therefore be out of sync.
|
||||||
|
|
2
SPEC.md
2
SPEC.md
|
@ -44,7 +44,7 @@ All connections are using unencrypted (TODO) websockets as the underlying networ
|
||||||
|
|
||||||
## Packet Structure
|
## Packet Structure
|
||||||
|
|
||||||
> **NOTE**
|
> [!IMPORTANT]
|
||||||
> Not yet implemented.
|
> Not yet implemented.
|
||||||
|
|
||||||
A complete packet is a [MessagePack](https://msgpack.org/)-encoded dictionary with the following fields:
|
A complete packet is a [MessagePack](https://msgpack.org/)-encoded dictionary with the following fields:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue