New APi - update main doc README

OpenRCS · Nov 16, 2019 · 43d2d71 · 43d2d71
1 parent 4a1b34b
commit 43d2d71
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -19,11 +19,12 @@ eliminating any support of ES5 environments (IE11 being the notable case).
 
 # Documentation
 
-* [SimpleUser](./simple-user/sip.js.md)
 * [API Overview](#api-overview)
 * [API Reference](./api/sip.js.md)
 * [Core Library Overview](#core-library-overview)
 * [Core Library Reference](./core/sip.js.md)
+* [SimpleUser Class Overview](#simpleuser-class-overview)
+* [SimpleUser Class Reference](./simple-user/sip.js.md)
 
 # API Overview
 
@@ -217,3 +218,8 @@ The `UserAgentCore` class provides the primary external interface with the SIP c
 - `UserAgentServer` implementation (https://tools.ietf.org/html/rfc3261#section-8.2)
 - Method specific extensions 
 
+# SimpleUser Class Overview
+
+Reference Documentation: [SimpleUser Class](./simple-user/sip.js.md)
+
+The `SimpleUser` class is a simplified interface to make getting up and running easier for new users. While it is not intended for advanced use cases, it is perhaps suitable for many simple single page web browser applications. For examples, see the [Demo](../demo/README.md)  page.