Skip to content

Commit

Permalink
Improve readme (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
roznawsk committed Jul 12, 2023
1 parent 3b049c3 commit c097290
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,37 @@

Jellyfish is an open-source, general-purpose media server that ships with support for multiple media protocols.
It can be thought of as a multimedia bridge meant for creating different types of multimedia systems that lets
you easily create a real-time video conferencing system, a broadcasting solution or both at the same time.
you easily create a real-time video conferencing system, a broadcasting solution, or both at the same time.

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/).

## Installation

There are two ways of running Jellyfish:
- building from source (requires Elixir and native dependencies)
- using Jellyfish Docker images (Remember that you should set `INTEGRATED_TURN_IP` env to your public IP address and `INTEGRATED_TURN_LISTEN_IP` to `0.0.0.0`).
- using Jellyfish Docker images

To learn more, refer to [Installation page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/installation) in Jellyfish docs.

## SDKs

Jellyfish provides server SDKs (used to manage the state of Jellyfish server) and client SDKs (used to connect to Jellyfish instance, receive media etc.).
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.).

To get list of all available SDKs, go to [SDKs page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/sdks) in Jellyfish docs.
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.

## Examples

- WebRTC Dashboard

Standalone dashboard that can create rooms, add peers, send media between the peers. Available [here](https://github.com/jellyfish-dev/jellyfish-react-client/tree/main/examples/dashboard).
A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/jellyfish-dev/jellyfish-react-client/tree/main/examples/dashboard).
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.
Dashboard make 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.
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.

## Documentation

Everything you need to get started with Jellyfish is available in the [Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/).

You can read about theoretical concepts and problems we encountered in [Jellybook](https://jellyfish-dev.github.io/book/).
You can read about theoretical concepts and problems we encountered in the [Jellybook](https://jellyfish-dev.github.io/book/).

## Copyright and License

Expand Down

0 comments on commit c097290

Please sign in to comment.