From 743e9bd83fb66f894f4b28d039f3e61404fc7249 Mon Sep 17 00:00:00 2001
From: eshcherb <33529668+eshcherb@users.noreply.github.com>
Date: Fri, 22 Nov 2019 17:49:37 -0600
Subject: [PATCH] Update README.md

[ROCm/roctracer commit: 2ee7893e6d8f715baa21078c5a1273b67c5b00ca]
---
 projects/roctracer/README.md | 34 ++++++++++++++++++++++++++++------
 1 file changed, 28 insertions(+), 6 deletions(-)

diff --git a/projects/roctracer/README.md b/projects/roctracer/README.md
index 8fca37a2fd..b4b92c6f15 100644
--- a/projects/roctracer/README.md
+++ b/projects/roctracer/README.md
@@ -1,27 +1,36 @@
 # ROC-tracer
 ```
-ROC-tracer library, Runtimes Generic Callback/Activity APIs.
+ROC-tracer library: Runtimes Generic Callback/Activity APIs.
 The goal of the implementation is to provide a generic independent from
 specific runtime profiler to trace API and asyncronous activity.
 
 The API provides functionality for registering the runtimes API callbacks and
 asyncronous activity records pool support.
+
+ROC-TX librray: code annotation evemts API
+Includes basic API: roctxMark, roctxRangePush, roctxRangePop.
 ```
 
 ## The library source tree
 ```
- - inc/roctracer.h - Library public API
+ - inc/roctracer.h - rocTacer library public API header
+ - inc/roctx.h - rocTX library puiblic API header
  - src  - Library sources
-   - core - Library API sources
-   - util - Library utils sources
+   - core - rocTracer library API sources
+   - roctx - rocTX library API sources
+   - util - library utils sources
  - test - test suit
    - MatrixTranspose - test based on HIP MatrixTranspose sample
 ```
 
 ## Documentation
 ```
- - API description: inc/roctracer.h
- - Code example: test/MatrixTranspose_test/MatrixTranspose.cpp
+ - API description/headers: 
+   - inc/roctracer.h
+   - inc/roctx.h
+ - Code examples:
+   - test/MatrixTranspose_test/MatrixTranspose.cpp
+   - test/MatrixTranspose/MatrixTranspose.cpp
 ```
 
 ## To build and run test
@@ -53,3 +62,16 @@ asyncronous activity records pool support.
  or
   make package && dpkg -i *.deb
 ```
+
+## Usage
+```
+rocTracer API:
+  To use the rocTracer API you need the API header and to link your application with roctracer .so librray:
+  - the API header: /opt/rocm/roctracer/include/roctracer.h
+  - the .so library: /opt/rocm/lib/libroctracer64.so
+
+rocTX API:
+  To use the rocTX API you need the API header and to link your application with rictx .so librray:
+  - the API header: /opt/rocm/roctracer/include/roctx.h
+  - the .so library: /opt/rocm/lib/libroctx64.so
+