RIC:1060: Change in PTL

[ric-plt/xapp-frame.git] / README.md

diff --git a/README.md b/README.md
index 3f91461..3d74dde 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # XAPP-FRAME
 
 ## Introduction
-**xapp-frame** is a simple framework for rapid development of RIC xapps, and supports various services essential for RIC xapps such as RESTful APIs, RMR (RIC Message Routing), database backend services and watching and populating config-map changes in K8S environment.
+**xapp-frame** is a simple framework for rapid development of RIC xapps, and supports various services essential for RIC xapps such as RESTful APIs, RMR (RIC Message Routing), logging, performance metrics and database backend services. It also provides configuration interface for reading, watching and populating config-map changes in K8S environment.
 
 ## Architecture
 
@@ -59,7 +59,7 @@ func main() {
 
 #### To run the generated executable binary locally, run the following command:
 
-    RMR_SEED_RT=config/uta_rtg.rt ./example-xapp -f config/config-file.yaml
+    RMR_SEED_RT=examples/config/uta_rtg.rt ./example_xapp -f examples/config/config-file.json
 
 Congratulations! You've just built your first **xapp** application.
 
@@ -169,6 +169,24 @@ Congratulations! You've just built your first **xapp** application.
     Resource.InjectQueryRoute("/ric/v1/user", handler, "GET", "foo", "bar", "id", "mykey")
     ```
 
+* Metrics: registering couple of counters
+    ```
+    metrics := []xapp.CounterOpts{
+               {Name: "RICIndicationsRx", Help: "The total number of RIC inidcation events received"},
+               {Name: "RICExampleMessageRx", Help: "The total number of RIC example messages received"},
+       }
+    xapp.Metric.RegisterCounterGroup(metrics, "MyXApp")
+
+    // Use curl-command to get metrics
+    curl http://localhost:8080/ric/v1/metrics
+    ```
+
+## Running unit tests
+  Unit tests of xApp-framework can be run as following:
+  ```
+  make test
+  ```
+
 ## Documentation
 
 ## Community