@ondewo/sip-client-angular 3.1.0 → 5.1.0

package/README.md

@@ -1,20 +1,35 @@
-<p align="center">
-  <a href="https://www.ondewo.com">
-    <img alt="ONDEWO Logo" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/github/ondewo_logo_github_2.png"/>
-  </a>
+<div align="center">
+  <table>
+    <tr>
+      <td>
+        <a href="https://ondewo.com/en/products/natural-language-understanding/">
+            <img width="400px" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/ondewo_we_automate_your_phone_calls.png"/>
+        </a>
+      </td>
+    </tr>
+    <tr>
+       <td align="center">
+          <a href="https://www.linkedin.com/company/ondewo "><img width="40px" src="https://cdn-icons-png.flaticon.com/512/3536/3536505.png"></a>
+          <a href="https://www.facebook.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733547.png"></a>
+          <a href="https://twitter.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733579.png"> </a>
+          <a href="https://www.instagram.com/ondewo.ai/"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/174/174855.png"></a>
+          <a href="https://badge.fury.io/js/%40ondewo%2Fsip-client-angular"><img src="https://badge.fury.io/js/%40ondewo%2Fsip-client-angular.svg" alt="npm version" height="32"></a>
+       </td>
+    </tr>
+  </table>
   <h1 align="center">
     ONDEWO SIP Client Angular
   </h1>
-  <p align="center">
-    <a href="https://badge.fury.io/js/%40ondewo%2Fsip-client-angular"><img src="https://badge.fury.io/js/%40ondewo%2Fsip-client-angular.svg" alt="npm version" height="18"></a>
-  </p>
-</p>
+</div>
 
-# @ondewo/sip-client-angular
+## Overview
 
-`@ondewo/sip-client-angular` is a compiled version of the [ONDEWO SIP API](https://github.com/ondewo/ondewo-sip-api). Here you can find the SIP API [documentation](https://ondewo.github.io/ondewo-sip-api/).
+`@ondewo/sip-client-angular` is a compiled version of the [ONDEWO SIP API](https://github.com/ondewo/ondewo-sip-api) using the [ONDEWO PROTO COMPILER](https://github.com/ondewo/ondewo-proto-compiler). Here you can find the SIP API [documentation](https://ondewo.github.io).
 
-## Installation
+ONDEWO APIs use [Protocol Buffers](https://github.com/google/protobuf) version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. The same interface definition is used for gRPC versions of the API in all languages.
+
+
+## Setup
 
 Using NPM:
 
@@ -22,6 +37,42 @@ Using NPM:
 npm i --save @ondewo/sip-client-angular
 ```
 
-## Documentation
+Using GitHub:
+
+```shell
+git clone https://github.com/ondewo/ondewo-sip-client-angular.git ## Clone repository
+cd ondewo-sip-client-angular                                      ## Change into repo-directoy
+make setup_developer_environment_locally                          ## Install dependencies
+```
+
+## Package structure
+
+```
+npm
+├── api
+│   └── ondewo
+│       └── sip
+│           ├── sip.pbconf.d.ts
+│           ├── sip.pb.d.ts
+│           └── sip.pbsc.d.ts
+├── esm2022
+│   ├── api
+│   │   └── ondewo
+│   │       └── sip
+│   │           ├── sip.pbconf.mjs
+│   │           ├── sip.pb.mjs
+│   │           └── sip.pbsc.mjs
+│   ├── ondewo-sip-client-angular.mjs
+│   └── public-api.mjs
+├── fesm2022
+│   ├── ondewo-sip-client-angular.mjs
+│   └── ondewo-sip-client-angular.mjs.map
+├── ondewo-sip-api
+│   └── README.md
+├── index.d.ts
+├── LICENSE
+├── package.json
+├── public-api.d.ts
+└── README.md
+```
 
-Read the full documentation on [GitHub](https://github.com/ondewo/ondewo-sip-client-angular).