X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=examples%2FREADME;h=7d523fd81f7c3efb18fe01b2d3e4e8dfb6d868fd;hb=5a9d175bb17fcc71aa19fc23458e485830b97e0a;hp=4b63eeee45a94f4d0c6e53f0ec93eb2c14a0dcb7;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git

diff --git a/examples/README b/examples/README
index 4b63eee..7d523fd 100644
--- a/examples/README
+++ b/examples/README
@@ -4,3 +4,28 @@ various aspects of how a user programme can use RMr to send
 and/or receive messages.  These programmes are fairly simple
 in nature, and in most cases error checking is not performed
 to keep the code simple.  
+
+
+Health Check
+	This is an example of how a health check process might
+	be implemented. It sends 1 or more messages to an RMR
+	application and waits for the response. The latency of
+	each round trip (mu-seconds) is written to the tty.
+	
+
+Message echoer
+	This is a simple process which returns the received message
+	back to the sender, optionally changing the message type
+	while leaving all other parts of the message unchanged.
+	This is a good verification for applications like the
+	health checker.
+
+Receiver
+	This is a simple receiver process which returns messages to
+	the sender when a specific type is sent.  Messages are checked
+	for accuracy when run with the example sender.
+
+Sender
+	A small sender which puts in information that lets the receiver
+	confirm that the message was received correctly (simple checksum
+	on portions of the payload and RMR header data.