Skip to content
This repository was archived by the owner on Sep 19, 2024. It is now read-only.

Commit ed67a27

Browse files
author
Michał Śledź
committedMay 4, 2022
Move TS code to a separate repository
1 parent 7c1c8b6 commit ed67a27

15 files changed

+101
-2532
lines changed
 

‎.circleci/config.yml

+2-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ jobs:
2828
- run: mix compile --force --warnings-as-errors
2929
- run: mix credo
3030
- run: mix docs && mix docs 2>&1 | (! grep -q "warning:")
31-
- run: cd assets && npm install
32-
- run: cd assets && npm run format:check
3331

3432
integration_test:
3533
docker:
@@ -49,12 +47,12 @@ jobs:
4947
- run: cd ./integration_test/test_videoroom && npm ci --prefix=assets
5048
- run: cd ./integration_test/test_videoroom && mix test
5149

52-
50+
5351

5452
workflows:
5553
version: 2
5654
build:
5755
jobs:
5856
- test
5957
- lint
60-
- integration_test
58+
- integration_test

‎README.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/membrane_rtc_engine)
55
[![CircleCI](https://circleci.com/gh/membraneframework/membrane_rtc_engine.svg?style=svg)](https://circleci.com/gh/membraneframework/membrane_rtc_engine)
66

7-
Client and server libraries for Membrane RTC Engine.
7+
Customizable Real-time Communication Engine/SFU library focused on WebRTC.
88

9-
## Documentation
9+
## Client SDKs
1010

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)
1415

1516
## Installation
1617

@@ -26,22 +27,17 @@ end
2627

2728
## Usage
2829

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.
3032

3133

3234
## Developing
3335

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`.
4037

41-
We also added `mix integration` task, which runs integration tests from `integration/test_videoroom`.
4238
## Copyright and License
4339

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)
4541

4642
[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_rtc_engine)
4743

‎assets/esbuild.js

-14
This file was deleted.

‎assets/js/const.ts

-28
This file was deleted.

‎assets/js/index.ts

-17
This file was deleted.

‎assets/js/mediaEvent.ts

-27
This file was deleted.

0 commit comments

Comments
 (0)