Added Docs and Readme.md

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

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
new file mode 100644 (file)
index 0000000..19a751d
--- /dev/null
+++ b/docs/user-guide.rst
@@ -0,0 +1,28 @@
+.. 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 xAPP (Python)
+============================================================================================ 
+-------------------------------------------------------------------------------------------- 
+User's Guide 
+-------------------------------------------------------------------------------------------- 
+ 
+Introduction 
+============================================================================================ 
+
+The RIC platform provides set of functions as part of xAPP Python Framework that the xAPPs can use to accomplish their tasks.
+This xAPP is envisioned to provide python xAPP developers, examples of implementing these sets of functions.
+Note, HW xAPP does not address/implement any RIC Usecases. 
+
+HelloWorld xAPP Features 
+============================================================================================ 
+
+RIC Platform provides many Frameworks, APIs and libraries to aid the development of xAPPs. All xAPPs will have some custom
+processing functional logic core to the xApp and some additional non-functional platform related processing using 
+these APIs and libraries. This xAPP attempts to show the usage of such additional platform processing using xapp RIC framework APIs and libraries.
+
+
+The Hello World xApp demonstrates how a python based xApp uses the A1, and E2 interfaces and persistent database read-write operations.
+