From cda1bb2ece15bad3f89ed4a82c4e18bf2981b76d Mon Sep 17 00:00:00 2001 From: Dimitri Staessens Date: Mon, 30 Dec 2019 15:33:48 +0100 Subject: Add intro to docs --- content/en/docs/Overview/_index.md | 24 ++++++++++++++++-------- content/en/docs/Overview/intro.jpg | Bin 0 -> 45612 bytes 2 files changed, 16 insertions(+), 8 deletions(-) create mode 100644 content/en/docs/Overview/intro.jpg (limited to 'content/en/docs/Overview') diff --git a/content/en/docs/Overview/_index.md b/content/en/docs/Overview/_index.md index b7c7036..33f6333 100644 --- a/content/en/docs/Overview/_index.md +++ b/content/en/docs/Overview/_index.md @@ -12,17 +12,25 @@ Under construction. {{% /pageinfo %}} Ouroboros is a (prototype) **distributed system** for packet network -communications. It consists of a C **library** that allows you to -write ouroboros-native programs and a bunch of **daemons** that allow -you to easily create your own (overlay) networks using ordinary PC -hardware (Linux, FreeBSD or MacOS X). +communications. It consists of a C **library** that allows you +to write ouroboros-native programs and the subsystem that consists of +a bunch of **daemons** that allow you to easily create your own +(overlay) networks using ordinary PC hardware (Linux, FreeBSD or MacOS +X). The **Ouroboros library** implements the **application API** (the Ouroboros alternative to POSIX sockets) and the **management API** -(the Ouroboros alternative to things like netlink sockets). All -**end-to-end transport functions** are implemented in the application -library, such as **reliability** (packet ordering, retransmission logic -etc) and transport **encryption**. +(the Ouroboros alternative to things like netlink sockets). + +{{
}} + +From an application perspective, all that's needed is to link your +application with Ouroboros and you can use the Ouroboros networking +primitives. + +All **end-to-end transport functions** are implemented in the +application library, such as **reliability** (packet ordering, +retransmission logic etc) and transport **encryption**. The Ouroboros daemons can be thought of as **software routers** that can be connected to each other. Each one has an address, diff --git a/content/en/docs/Overview/intro.jpg b/content/en/docs/Overview/intro.jpg new file mode 100644 index 0000000..0a159e0 Binary files /dev/null and b/content/en/docs/Overview/intro.jpg differ -- cgit v1.2.3