@ondewo/sip-client-angular 4.0.0 → 5.1.0

package/ondewo-sip-api/README.md

@@ -1,86 +0,0 @@
-![Logo](https://raw.githubusercontent.com/ondewo/ondewo-logos/master/github/ondewo_logo_github_2.png)
-
-# ONDEWO SIP APIs
-
-This repository contains the original interface definitions of public ONDEWO APIs that support gRPC protocols. Reading the original interface definitions can provide a better understanding of ONDEWO APIs and help you to utilize them more efficiently. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts.
-
-The core componenets of all the client libraries are built directly from files in this repo using [the proto compiler.](https://github.com/ondewo/ondewo-proto-compiler)
-
-For an end-user, the APIS in this repo function mostly as documentation for the endpoints. For specific implementations, look in the following repos for working implementations:
-* [Python](https://github.com/ondewo/ondewo-sip-client-python)
-
-Please note that some of these implementations are works-in-progress. The repo will make clear the status of the implementation.
-
-## Overview
-
-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.
-
-There are several ways of accessing APIs:
-
-1.  Protocol Buffers over gRPC: You can access APIs published in this repository through [GRPC](https://github.com/grpc), which is a high-performance binary RPC protocol over HTTP/2. It offers many useful features, including request/response multiplex and full-duplex streaming.
-
-2.  ONDEWO Client Libraries:
-You can use these libraries to access ONDEWO Cloud APIs. They are based on gRPC for better performance and provide idiomatic client surface for better developer experience.
-
-## Discussions
-
-Please use the issue tracker in this repo for discussions about this API, or the issue tracker in the relevant client if it is language-specific.
-
-## Repository Structure
-
-```
-.
-├── CONTRIBUTING.md
-├── LICENSE
-├── ondewo
-│   └── sip
-│       └── sip.proto
-├── README.md
-└── RELEASE.md
-```
-
-## Generate gRPC Source Code
-
-API client libraries can be built directly from files in this repo using [the proto compiler.](https://github.com/ondewo/ondewo-proto-compiler)
-
-Automatic Release Process
-------------------
-The entire process is automated to make development easier. The actual steps are simple:
-
-TODOs in Pull Request before the release:
-
- - Update the Version number inside the Makefile
-
- - Check if RELEASE.md is up-to-date
-
-TODOs after Pull Request was merged in:
-
- - Checkout master:
-    ```bash
-    git checkout master
-    ```
- - Pull the new stuff:
-    ```bash
-    git pull
-    ```
- - Release:
-    ```bash
-    make ondewo_release
-    ```
-
-The   ``` make ondewo_release``` command can be divided into 5 steps:
-
-- cloning the devops-accounts repository and extracting the credentials
-- creating and pushing the release branch
-- creating and pushing the release tag
-- creating the GitHub release
-
-The variable for the GitHub Access Token is inside the Makefile,
-but the value is overwritten during ``` make ondewo_release```, because
-it is passed from the devops-accounts repo as an argument to the actual ```release``` command.
-
-Proto Documentation
--------------------
-
-Documentation for the .proto files is generated automatically when there is a pullrequest or push
-to master. It is located in the branch [gh-pages](https://github.com/ondewo/ondewo-sip-api/tree/gh-pages).