Added Docs and Readme.md

[ric-app/hw-python.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..be50c76
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
+
+
+
+
+HelloWorld Python xAPP  Overview
+================================
+
+This repository contains open-source code for a prototype python xAPP for near real-time
+RAN Intelligent Controller which makes use of python Xapp Framework.
+This xAPP aims to provide basic implementation of :
+
+-E2, A1 interfaces interactions.
+
+-Read-write operations into a persistent storage. 
+
+-xAPP Configuration management
+
+-RMR Health Check
+
+-xAPP Health Check
+
+-Raising alarms
+
+-Generating metrics