@fishjam-cloud/react-client/readme.md

React client library for Fishjam

<img src="../../.github/images/fishjam-card.png" width="100%" />

# Fishjam React client

`@fishjam-cloud/react-client` is an easiest way to add video streaming to your React web app.

# Installation

Check out the [installation](https://docs.fishjam.io/react/installation) section of our docs for the detailed installation instructions.

# Documentation

Check out our [documentation](https://docs.fishjam.io/) on how Fishjam work and how to integrate our service with your app.

There is also [API documentation](https://docs.fishjam.io/api/web/) available.

# Examples

There are [few example apps](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client#examples-for-fishjam-client) that shows how to use Fishjam SDKs and service.

- [Fishjam Chat](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client/fishjam-chat) - example video chat app
- [minimal-react](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client/minimal-react) - minimal example that shows how to connect and share your screen
- [broadcast](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client/broadcast) - minimal example showing how to consume a broadcast stream

## License

Licensed under the [Apache License, Version 2.0](./LICENSE.txt)

## Fishjam is created by Software Mansion

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile
apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help
you build your next dream product –
[Hire us](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme).

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=react-client)](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme)