Add readme and metadata, no functional change

[ric-plt/a1.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..943c194
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# RIC A1 Mediator
+
+The xApp A1 mediator exposes a generic REST API by which xApps can
+receive and send northbound messages.  The A1 mediator will take
+the payload from such generic REST messages, validate the payload,
+and then communicate the payload to the xApp via RMR messaging.
+
+Please see documentation in the docs/ subdirectory.