X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;h=e4cb20c0eda8d26ceb52d72929d6634209951c68;hb=fe6a856df463a0d7e06b28aac8590ac9c0f08dd6;hp=7f45ec819a21bc57c28e06992f3ce397977cc8e4;hpb=d961525e9eb23e3dee4a16960a1772782c3b8b36;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 7f45ec8..e4cb20c 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -9,18 +9,22 @@ RMR User's Guide ============================================================================================ -The RIC Message Router (RMR) is a library which applications -use to send and receive messages where the message routing, -endpoint selection, is based on the message type rather than -on traditional DNS names or IP addresses. Because the user -documentation for RMR is a collection of UNIX manpages -(included in the development package, and available via the -man command when installed), there is no separate "User's -Guide." To provide something for the document scrapers to -find, this is a collection of the RMR manual pages formatted -directly from their source which might be a bit ragged when -combined into a single markup document. Read the manual pages -:) +The RIC Message Router (RMR) is a library for peer-to-peer +communication. Applications use the library to send and +receive messages where the message routing and endpoint +selection is based on the message type rather than DNS host +name-IP port combinations. + +This document contains information that developers need to +know to use the RMR library. Because the primary +documentation for the RMR library is a collection of UNIX +manpages (included in the development package, and available +via the man command when installed), there is no separate +"User's Guide." To provide something for the document +scrapers to find, this is a collection of the RMR manual +pages formatted directly from their source, which might be a +bit ragged when combined into a single markup document. Read +the manual pages :)