aboutsummaryrefslogtreecommitdiff
path: root/content/en/docs/Overview
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri@ouroboros.rocks>2019-12-30 15:33:48 +0100
committerDimitri Staessens <dimitri@ouroboros.rocks>2019-12-30 15:33:48 +0100
commitcda1bb2ece15bad3f89ed4a82c4e18bf2981b76d (patch)
tree93c94d9ddced0b049d65645ea9680ae04d7f7798 /content/en/docs/Overview
parent1b76e8162deb2739a06f1692056051a1d4ba3ab0 (diff)
downloadwebsite-cda1bb2ece15bad3f89ed4a82c4e18bf2981b76d.tar.gz
website-cda1bb2ece15bad3f89ed4a82c4e18bf2981b76d.zip
Add intro to docs
Diffstat (limited to 'content/en/docs/Overview')
-rw-r--r--content/en/docs/Overview/_index.md24
-rw-r--r--content/en/docs/Overview/intro.jpgbin0 -> 45612 bytes
2 files changed, 16 insertions, 8 deletions
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).
+
+{{<figure width="60%" src="/docs/overview/intro.jpg">}}
+
+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
--- /dev/null
+++ b/content/en/docs/Overview/intro.jpg
Binary files differ