diff --git a/README.md b/README.md index 88275cf..bf62c1e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ - # Fishjam iOS Client + [Fishjam](https://github.com/fishjam-dev/fishjam) Client library for iOS apps written in Swift. ## Components -The repository consists of 3 separapable components: +The repository consists of 3 separate components: -- `JellyfishClientSdk` - Fishjam client fully compatible with `Fishjam`, responsible for exchaning media events and receiving media streams which then are presented to the user +- `JellyfishClientSdk` - Fishjam client fully compatible with `Fishjam`, responsible for exchanging media events and + receiving media streams which then are presented to the user - `JellyfishCLientDemo` - Demo application utilizing `Fishjam` client -- `MembraneRTC` - iOS webrtc client +- `MembraneRTC` - iOS WebRTC client ### Example App @@ -18,6 +19,7 @@ Really simple App allowing to test `Fishjam client` functionalities. It consist - Room's screen consisting of set of control buttons and an area where participants' videos get displayed ## Documentation + API documentation is available [here](https://fishjam-dev.github.io/ios-client-sdk/documentation/fishjamclientsdk/). ## Installation @@ -28,23 +30,25 @@ Add FishjamClientSDK dependency to your project. 1. Run `./scripts/init.sh` in the main directory to install swift-format and release-it and set up git hooks 2. Edit `Debug.xcconfig` to set backend url in development. -3. Run `release-it` to release. Follow the prompts, it should update version in podspec, make a commit and tag and push the new version. +3. Run `release-it` to release. Follow the prompts, it should update version in podspec, make a commit and tag and push + the new version. ## Contributing -We welcome contributions to iOS Client SDK. Please report any bugs or issues you find or feel free to make a pull request with your own bug fixes and/or features. +We welcome contributions to iOS Client SDK. Please report any bugs or issues you find or feel free to make a pull +request with your own bug fixes and/or features. ## Fishjam Ecosystem | | | -| ----------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Client SDKs | [React](https://github.com/fishjam-dev/react-client-sdk), [React Native](https://github.com/fishjam-dev/react-native-client-sdk), [iOS](https://github.com/fishjam-dev/ios-client-sdk), [Android](https://github.com/fishjam-dev/android-client-sdk) | | Server SDKs | [Elixir](https://github.com/fishjam-dev/elixir_server_sdk), [Python](https://github.com/fishjam-dev/python-server-sdk), [OpenAPI](https://fishjam-dev.github.io/fishjam-docs/for_developers/api_reference/rest_api) | | Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities | | Resources | [Fishjam Book](https://fishjam-dev.github.io/book/) - theory of the framework, [Docs](https://fishjam-dev.github.io/fishjam-docs/), [Tutorials](https://github.com/fishjam-dev/fishjam-clients-tutorials) | | Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | | Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | -| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) +| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) | ## Copyright and License