X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=fa7818fc388f3b7d83dbe15de8a9266486a844ed;hb=refs%2Fchanges%2F49%2F11549%2F1;hp=ce1339bbad9a45323a12f95cf1cdc6dc0774cd4d;hpb=347f178c656d82aa0c6d4ab56eb0846a94d7af40;p=nonrtric%2Fplt%2Frappmanager.git

diff --git a/README.md b/README.md
index ce1339b..fa7818f 100755
--- a/README.md
+++ b/README.md
@@ -3,8 +3,67 @@ Rapp manager is an application which lifecycle manages the Rapp.
 
 <mark>**Rapp packaging model used here is purely a prototype**</mark>
 
-# Integration of ONAP ACM
+## Architecture
+
+![Image](docs/images/architecture.png "Rapp Manager Architecture")
+
+### Rapp States
+
+![Image](docs/images/rapp-states.png "Rapp States")
+
+### Rapp Instance States
+
+![Image](docs/images/rapp-instance-states.png "Rapp Instance States")
+
+### Events responsible for Rapp Instance State Transition
+
+![Image](docs/images/rapp-state-events.png "Rapp Manager State Events")
+
+## Integrations
+
+### ONAP ACM
 
 ONAP ACM is used here as a backend of Rapp manager to lifecycle manage the deployment items as part of Rapp.
 
 ONAP ACM related details can be found [here](https://docs.onap.org/projects/onap-policy-parent/en/london/clamp/clamp.html).
+
+
+### Integration of SME (CAPIF)
+
+This integration is based on the CAPIF function developed as part of ORAN-SC. It is available [here](https://github.com/o-ran-sc/nonrtric-plt-sme/blob/master/capifcore/README.md)
+
+## Flow Diagrams
+
+### Application Lifecycle
+
+![Image](docs/images/application-lifecycle.png "Rapp Manager Application Lifecycle")
+
+### Rapp Flow
+
+![Image](docs/images/rapp-flow.png "Rapp Flow")
+
+### Rapp Instance Flow
+
+![Image](docs/images/rapp-instance-flow.png "Rapp Instance Flow")
+
+
+## Maven Build
+
+This build supports Linux and Windows environments.
+
+In case of below error during the build in Windows environment,
+
+```
+[INFO] --- exec-maven-plugin:3.1.0:exec (git submodule update) @ rapp-manager-sme ---
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: basename: command not found
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 7: sed: command not found
+C:/Program Files/Git/mingw64/libexec/git-core\git-submodule: line 22: .: git-sh-setup: file not found
+```
+
+It is necessary to append additional paths listed below to the <strong>System</strong> environment variable
+named "<strong>PATH</strong>". These paths can vary based on the git installation location.
+
+```
+C:\Program Files\Git\usr\bin
+C:\Program Files\Git\mingw64\libexec\git-core
+```