|
4 | 4 | [](https://hexdocs.pm/membrane_rtc_engine)
|
5 | 5 | [](https://circleci.com/gh/membraneframework/membrane_rtc_engine)
|
6 | 6 |
|
7 |
| -Client and server libraries for Membrane RTC Engine. |
| 7 | +Customizable Real-time Communication Engine/SFU library focused on WebRTC. |
8 | 8 |
|
9 |
| -## Documentation |
| 9 | +## Client SDKs |
10 | 10 |
|
11 |
| -Documentation of client library is available at https://hexdocs.pm/membrane_rtc_engine/js |
12 |
| - |
13 |
| -Documentation of server library is available at https://hexdocs.pm/membrane_rtc_engine |
| 11 | +* [JS/TS](https://github.com/membraneframework/membrane-webrtc-js) |
| 12 | +* [Android](https://github.com/membraneframework/membrane-webrtc-android) |
| 13 | +* [iOS](https://github.com/membraneframework/membrane-webrtc-ios) |
| 14 | +* [React Native](https://github.com/membraneframework/react-native-membrane-webrtc) |
14 | 15 |
|
15 | 16 | ## Installation
|
16 | 17 |
|
|
26 | 27 |
|
27 | 28 | ## Usage
|
28 | 29 |
|
29 |
| -For usage examples, please refer to our [membrane_demo](https://github.com/membraneframework/membrane_demo/tree/master/webrtc/videoroom) repository. |
| 30 | +For usage examples, please refer to our [membrane_demo](https://github.com/membraneframework/membrane_demo/tree/master/webrtc/videoroom) or |
| 31 | +[membrane_videoroom](https://github.com/membraneframework/membrane_videoroom) repositories. |
30 | 32 |
|
31 | 33 |
|
32 | 34 | ## Developing
|
33 | 35 |
|
34 |
| -To make the development a little easier, we augmented `mix compile` and `mix docs` tasks so that `mix compile` also installs npm dependencies and compiles TypeScript code |
35 |
| -and `mix docs` also generates documentation for TypeScript code. |
36 |
| - |
37 |
| -Thanks to this, there is no need to include compiled JS code in `priv/static`. It will be generated each time `mix compile` is called. |
38 |
| - |
39 |
| -TypeScript documentation will be generated under `doc/js/`. |
| 36 | +To make the development a little easier, we have added `mix integration_test` task, which runs integration tests from `integration/test_videoroom`. |
40 | 37 |
|
41 |
| -We also added `mix integration` task, which runs integration tests from `integration/test_videoroom`. |
42 | 38 | ## Copyright and License
|
43 | 39 |
|
44 |
| -Copyright 2021, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_rtc_engine) |
| 40 | +Copyright 2022, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_rtc_engine) |
45 | 41 |
|
46 | 42 | [](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_rtc_engine)
|
47 | 43 |
|
|
0 commit comments