From a970af33ddc3bf8782bf49d1de4006180e3e1c08 Mon Sep 17 00:00:00 2001 From: David Zhao Date: Sun, 28 Nov 2021 22:12:02 -0800 Subject: [PATCH] Add other end to end projects that use ion-sfu (#622) --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 1adafa6fc..161701e37 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,22 @@ A [selective forwarding unit](https://webrtcglossary.com/sfu/) is a video routing service which allows webrtc sessions to scale more efficiently. This package provides a simple, flexible, high performance Go implementation of a WebRTC SFU. It can be called directly or through a [gRPC](cmd/signal/grpc) or [json-rpc](cmd/signal/json-rpc) interface. ## Features + * Audio/Video/Datachannel forwarding * Congestion Control (TWCC, REMB, RR/SR) * Unified plan semantics * Pub/Sub Peer Connection (`O(n)` port usage) * Audio level indication (RFC6464). "X is speaking" +## End to end solutions + +ion-sfu is the engine behind several projects. It's designed to be focused, with minimal signaling or external dependencies. It's simple to embed ion-sfu within your service: we include a few examples inside `cmd/signal`. + +For "batteries-included", end-to-end solutions that are easier to deploy, check out: + +* [LiveKit](https://github.com/livekit/livekit-server): Open source platform for real-time communication (SDKs for all major platforms) +* [Ion](https://github.com/pion/ion): Real-Distributed RTC System by pure Go and Flutter + ## Quickstart Run the Echo Test example @@ -88,6 +98,7 @@ MIT License - see [LICENSE](LICENSE) for full text ## Development Generate the protocol buffers and grpc code: + 1. Best choice (uses docker): `make protos`. 2. Manually: - Install protocol buffers and the protcol buffers compiler. On Fedora `dnf install protobuf protobuf-compiler`.