From 584aa8c84cbf8505e8321c1b73ef96dc380932ec Mon Sep 17 00:00:00 2001
From: Thijs <33511165+ThijsSassen@users.noreply.github.com>
Date: Wed, 11 Dec 2019 17:14:57 +0100
Subject: [PATCH] added Readme (#298)

added readme with known limitations of Vortex OpenSplice

Signed-off-by: Thijs Sassen <thijs.sassen@adlinktech.com>
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1475b52
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# A ROS 2 RMW implementation for Vortex OpenSplice
+
+With the code in this repository, it is possible to use [*ROS 2*](https://index.ros.org/doc/ros2)
+with [*Vortex OpenSplice*](https://github.com/ADLINK-IST/opensplice) as the underlying DDS
+implementation.
+
+## Known limitations
+
+MANUAL_BY_TOPIC Liveliness QoS is not supported by OpenSplice when used with DDSi network service.