|
1 |
| -# Jellyfish |
| 1 | +# Fishjam |
2 | 2 |
|
3 |
| -[](https://codecov.io/gh/jellyfish-dev/jellyfish) |
4 |
| -[](https://circleci.com/gh/jellyfish-dev/jellyfish) |
| 3 | +[](https://codecov.io/gh/fishjam-dev/fishjam) |
| 4 | +[](https://circleci.com/gh/fishjam-dev/fishjam) |
5 | 5 |
|
6 |
| -Jellyfish is an open-source, general-purpose media server that ships with support for multiple media protocols. |
| 6 | +Fishjam is an open-source, general-purpose media server that ships with support for multiple media protocols. |
7 | 7 | It can be thought of as a multimedia bridge meant for creating different types of multimedia systems that lets
|
8 | 8 | you easily create a real-time video conferencing system, a broadcasting solution, or both at the same time.
|
9 | 9 |
|
10 |
| -It leverages the [Membrane RTC Engine](https://github.com/jellyfish-dev/membrane_rtc_engine), a real-time communication engine/SFU library built with [Membrane](https://membrane.stream/). |
| 10 | +It leverages the [Membrane RTC Engine](https://github.com/fishjam-dev/membrane_rtc_engine), a real-time communication engine/SFU library built with [Membrane](https://membrane.stream/). |
11 | 11 |
|
12 | 12 | ## Installation
|
13 | 13 |
|
14 |
| -There are two ways of running Jellyfish: |
| 14 | +There are two ways of running Fishjam: |
15 | 15 | - building from source (requires Elixir and native dependencies)
|
16 |
| -- using Jellyfish Docker images |
| 16 | +- using Fishjam Docker images |
17 | 17 |
|
18 |
| -To learn more, refer to [Installation page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/installation) in Jellyfish docs. |
| 18 | +To learn more, refer to [Installation page](https://fishjam-dev.github.io/fishjam-docs/getting_started/installation) in Fishjam docs. |
19 | 19 |
|
20 | 20 | ## SDKs
|
21 | 21 |
|
22 |
| -Jellyfish provides server SDKs (used to manage the state of Jellyfish server) and client SDKs (used to connect to the Jellyfish instance, receive media, etc.). |
| 22 | +Fishjam provides server SDKs (used to manage the state of Fishjam server) and client SDKs (used to connect to the Fishjam instance, receive media, etc.). |
23 | 23 |
|
24 |
| -To get the list of all available SDKs, go to [SDKs page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/sdks) in Jellyfish docs. |
| 24 | +To get the list of all available SDKs, go to [SDKs page](https://fishjam-dev.github.io/fishjam-docs/getting_started/sdks) in Fishjam docs. |
25 | 25 |
|
26 | 26 | ## Examples
|
27 | 27 |
|
28 | 28 | - WebRTC Dashboard
|
29 | 29 |
|
30 |
| - A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/jellyfish-dev/jellyfish-dashboard). |
31 |
| -To use the dashboard, you need to set up Jellyfish with WebRTC, refer to [WebRTC peer page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/peers/webrtc) in Jellyfish docs to learn how to do that. |
32 |
| -Dashboard makes HTTP requests to Jellyfish that need to be authorized and requires a token to do so, learn more from [Authentication page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/authentication) in Jellyfish docs. |
| 30 | + A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/fishjam-dev/fishjam-dashboard). |
| 31 | +To use the dashboard, you need to set up Fishjam with WebRTC, refer to [WebRTC peer page](https://fishjam-dev.github.io/fishjam-docs/getting_started/peers/webrtc) in Fishjam docs to learn how to do that. |
| 32 | +Dashboard makes HTTP requests to Fishjam that need to be authorized and requires a token to do so, learn more from [Authentication page](https://fishjam-dev.github.io/fishjam-docs/getting_started/authentication) in Fishjam docs. |
33 | 33 |
|
34 | 34 | ## Documentation
|
35 | 35 |
|
36 |
| -Everything you need to get started with Jellyfish is available in the [Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/). |
| 36 | +Everything you need to get started with Fishjam is available in the [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/). |
37 | 37 |
|
38 |
| -You can read about theoretical concepts and problems we encountered in the [Jellybook](https://jellyfish-dev.github.io/book/). |
| 38 | +You can read about theoretical concepts and problems we encountered in the [Fishjambook](https://fishjam-dev.github.io/book/). |
39 | 39 |
|
40 | 40 | ## Copyright and License
|
41 | 41 |
|
42 |
| -Copyright 2022, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) |
| 42 | +Copyright 2022, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam) |
43 | 43 |
|
44 |
| -[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) |
| 44 | +[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam) |
45 | 45 |
|
46 | 46 | Licensed under the [Apache License, Version 2.0](LICENSE)
|
0 commit comments