Improve documentation

[nonrtric/rapp/orufhrecovery.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..9b1eda8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+<!--
+ -
+   ========================LICENSE_START=================================
+   O-RAN-SC
+   %%
+   Copyright (C) 2023: Nordix Foundation
+   %%
+   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.
+   ========================LICENSE_END===================================
+
+-->
+
+# O-RAN-SC Non-RealTime RIC O-RU Fronthaul Recovery rApp
+
+There are three implementations available for this rApp.
+
+- The Go version that uses Information Coordinator Service (ICS) to create a job that provides info about the Fronthaul state, see [Go version](goversion/README.md).
+- The script version that polls DMaaP Message Router for info about the Fronthaul state, see [script version](scriptversion/README.md).