Skip to content

Commit b39cb00

Browse files
authored
Update README.md (#215)
* Update README.md Update readme to link to fishjam.io * Update README.md 2
1 parent 5ddd4aa commit b39cb00

1 file changed

Lines changed: 6 additions & 35 deletions

File tree

README.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,12 @@
1-
# Fishjam
1+
# Moving forward with Fishjam
22

3-
[![codecov](https://codecov.io/gh/fishjam-dev/fishjam/branch/main/graph/badge.svg?token=ANWFKV2EDP)](https://codecov.io/gh/fishjam-dev/fishjam)
4-
[![CircleCI](https://circleci.com/gh/fishjam-dev/fishjam.svg?style=svg)](https://circleci.com/gh/fishjam-dev/fishjam)
3+
Fishjam Media Server is evolving into [Fishjam](https://fishjam.io/).
54

6-
Fishjam is an open-source, general-purpose media server that ships with support for multiple media protocols.
7-
It can be thought of as a multimedia bridge meant for creating different types of multimedia systems that lets
8-
you easily create a real-time video conferencing system, a broadcasting solution, or both at the same time.
5+
## Please note
6+
This repository refers to the original Fishjam media server, which was an open-source general purpose media server written in Elixir.
7+
If you run your product on Fishjam Media Server and these changes affect your business, please contact us via projects@swmansion.com.
98

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-
12-
## Installation
13-
14-
There are two ways of running Fishjam:
15-
- building from source (requires Elixir and native dependencies)
16-
- using Fishjam Docker images
17-
18-
To learn more, refer to [Installation page](https://fishjam-dev.github.io/fishjam-docs/getting_started/installation) in Fishjam docs.
19-
20-
## SDKs
21-
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-
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-
26-
## Examples
27-
28-
- WebRTC Dashboard
29-
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-
34-
## Documentation
35-
36-
Everything you need to get started with Fishjam is available in the [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/).
37-
38-
You can read about theoretical concepts and problems we encountered in the [Fishjambook](https://fishjam-dev.github.io/book/).
9+
**This project is no longer being maintained or updated.**
3910

4011
## Copyright and License
4112

0 commit comments

Comments
 (0)