Skip to content

Commit

Permalink
New API - documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
John Riordan committed Nov 28, 2019
1 parent 8736786 commit acbbf56
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,11 @@ Herein lies Session Initiation Protocol (SIP) protocol software enabling interne

### SimpleUser class

The [SimpleUser](./simple-user.md) class provides a representation of a simple internet endpoint (a simple user agent). It requires an understanding of what a phone call is (but minimal knowledge of SIP) and
fluency in JavaScript (for example, how to use a `Promise`). There are working [Demonstrations](../demo
README.md) provided to help get started and it is recommended interface for many applications (it has its
limitations). The [SimpleUser](./simple-user.md) class is implemented on top of the [API](./api.md)
framework.
The [SimpleUser](./simple-user.md) class provides a representation of a simple internet endpoint (a simple user agent). It requires an understanding of what a phone call is (but minimal knowledge of SIP) and fluency in JavaScript (for example, how to use a `Promise`). There are working [Demonstrations](../demo/README.md) provided to help get started. It is the recommended interface for many applications. It has its limitations. The [SimpleUser](./simple-user.md) class is implemented on top of the [API](./api.md) framework.

### API framework

The [API](./api.md) framework is intended to provide a complete and suitable framework on which to build most end user applications (business phone, video conferencing endpoint, smart doorbell, etc.). A working knowledge of the SIP protocol is a prerequisite for using it. (The SIP protocol is an internet standard the details of which are well beyond the scope of the documentation here. However, there are many resources available on the internet.) The framework provides infrastructure to connect with a SIP server as well as setup and maintain SIP registrations, sessions and subscriptions (there are no user interface components in it). The source code of the [SimpleUser](./simple-user.md) class is well documented and provides a good example of how to get started using the [API](./api.md) framework. The framework is implemented on top of the [Core](./core.md) library.
The [API](./api.md) framework is intended to provide a complete and suitable framework on which to build most end user applications - business phones, video conferencing endpoints, smart doorbells. A working knowledge of the SIP protocol is a prerequisite for using it. (The SIP protocol is an internet standard the details of which are well beyond the scope of the documentation here. However, there are many resources available on the internet.) The framework provides infrastructure to connect with a SIP server as well as setup and maintain SIP registrations, sessions and subscription. Tthere are no user interface components in it. The source code of the [SimpleUser](./simple-user.md) class is well documented and provides a good example of how to get started using the [API](./api.md) framework. The framework is implemented on top of the [Core](./core.md) library.

### Core library

Expand Down

0 comments on commit acbbf56

Please sign in to comment.