From dfb7940d17b472b407729aff747f7e3d918564d8 Mon Sep 17 00:00:00 2001
From: Simon Duquennoy <simon.duquennoy@gmail.com>
Date: Wed, 1 Nov 2017 09:27:51 +0100
Subject: [PATCH] Added general RPL border router readme

---
 examples/rpl-border-router/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 examples/rpl-border-router/README.md

diff --git a/examples/rpl-border-router/README.md b/examples/rpl-border-router/README.md
new file mode 100644
index 0000000000..2ad4dbff58
--- /dev/null
+++ b/examples/rpl-border-router/README.md
@@ -0,0 +1,27 @@
+This is the Contiki-NG border router. It supports two main modes of operation:
+embedded and native. In both cases, the border router runs a simple Web server
+that exposes a list of currently connected nodes via HTTP.
+
+See https://github.com/contiki-ng/contiki-ng/wiki/Tutorial:-RPL-border-router
+
+# Embedded border router
+
+The embedded border router runs on a node. It is connected to the host via SLIP.
+The host simply runs a tun gateway (`tunslip6`). To use, program a node, and
+then start `tunslip6` on the host via the make command `connect-router`.
+See embedded/README.md for more.
+
+# Native border router
+
+The native border router runs directly at the host. The node simply runs a
+SLIP-radio interface (`examples/slip-radio`). The host, on the other hand, runs
+a full 6LoWPAN stack.
+See native/README.md for more.
+
+# RPL node
+
+As RPL node, you may use any Contiki-NG example with RPL enabled, but which
+does not start its own DAG (as this is the responsibility of the border router).
+For instance `examples/hello-world` or `examples-coap` are great starting
+points. This is not intended to run with `examples/rpl-udp` however, as this
+examples builds its own stand-alone, border-router-free RPL network.
-- 
GitLab