Adding Bouncer code for RIC-Benchmarking

[ric-app/bouncer.git] / Bouncer / docs / overview.rst

diff --git a/Bouncer/docs/overview.rst b/Bouncer/docs/overview.rst
new file mode 100644 (file)
index 0000000..d3a37db
--- /dev/null
+++ b/Bouncer/docs/overview.rst
@@ -0,0 +1,38 @@
+# ==================================================================================
+# Copyright (c) 2020 HCL Technologies Limited.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==================================================================================
+
+
+
+Bouncer xAPP  Overview
+================================
+
+The Bouncer xAPP repository contains open-source code for a prototype xAPP for near real-time
+RAN Intelligent Controller. The Bouncer xAPP aims to provide basic RIC Benchmarking implementation of :
+
+-E2 interfaces interactions.
+
+-xAPP Configuration management.
+
+-E2 subscription handling
+
+-Receiving E2 RIC Indication
+
+
+The Bouncer xAPP code is intended to follow xAPP C++ Framework to implement the prototype.
+
+
+
+