@stream-io/video-react-native-sdk 0.0.1-alpha.169 → 0.0.1-alpha.170

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.0.1-alpha.170](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-native-sdk-0.0.1-alpha.169...@stream-io/video-react-native-sdk-0.0.1-alpha.170) (2023-06-16)
+
+
+
 ## [0.0.1-alpha.169](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-native-sdk-0.0.1-alpha.168...@stream-io/video-react-native-sdk-0.0.1-alpha.169) (2023-06-16)
 
 

package/README.md

@@ -1,3 +1,120 @@
-# @stream-io/react-native-sdk
+# Official React Native SDK for [Stream Video](https://getstream.io/video/docs/)
+## 🚧 WARNING This package is not yet stable, it is for internal use only. For more information check out our video product page. 🚧
 
- ## 🚧 WARNING This package is not yet stable, it is for internal use only. For more information check out our video product page. 🚧
+// TODO - image for the SDK
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=GetStream_stream-video-js&metric=alert_status&token=fdc1439303911957da9c7ff2ce505f94c3c14d36)](https://sonarcloud.io/summary/new_code?id=GetStream_stream-video-js)
+[![SDK Releases](https://img.shields.io/github/v/release/GetStream/stream-video-js)](https://github.com/GetStream/stream-video-js/releases)
+[![SDK Sample App CI](https://github.com/GetStream/stream-video-js/workflows/React%20Native%20Dogfood%20Release/badge.svg)](https://github.com/GetStream/stream-video-js/actions/workflows/react-native-workflow.yml)
+
+## **Quick Links**
+- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Video
+- [React Native Video Tutorial]() //TODO- add link
+- [Sample application](https://github.com/GetStream/stream-video-js/tree/main/sample-apps/react-native/dogfood)
+
+## **What is Stream?**
+
+Stream allows developers to rapidly deploy scalable feeds, chat messaging and video with an industry leading 99.999% uptime SLA guarantee.
+
+With Stream's video components, you can use their SDK to build in-app video calling, audio rooms, audio calls, or live streaming. The best place to get started is with their tutorials:
+
+- Video & Audio Calling Tutorial
+- Audio Rooms Tutorial
+- Livestreaming Tutorial
+
+Stream provides UI components and state handling that make it easy to build video calling for your app. All calls run on Stream's network of edge servers around the world, ensuring optimal latency and reliability.
+
+## 👩‍💻 Free for Makers 👨‍💻
+
+Stream is free for most side and hobby projects. To qualify, your project/company needs to have < 5 team members and < $10k in monthly revenue. Makers get $100 in monthly credit for video for free.
+
+## 💡Supported Features💡
+
+Here are some of the features we support:
+- Developer experience: Great SDKs, docs, tutorials and support so you can build quickly
+- Edge network: Servers around the world ensure optimal latency and reliability
+- Chat: Stored chat, reactions, threads, typing indicators, URL previews etc
+- Security & Privacy: Based in USA and EU, Soc2 certified, GDPR compliant
+- Dynascale: Automatically switch resolutions, fps, bitrate, codecs and paginate video on large calls
+- Screen sharing (To be implemented)
+- Picture-in-picture support (To be implemented)
+- Active speaker
+- Custom events
+- Geofencing
+- Notifications and ringing calls
+- Opus DTX & Red for reliable audio
+- Webhooks & SQS
+- Backstage mode
+- Flexible permissions system
+- Joining calls by ID, link or invite
+- Enabling and disabling audio and video when in calls
+- Flipping, Enabling and disabling camera in calls
+- Enabling and disabling speakerphone in calls
+- Push notification providers support
+- Call recording (To be implemented)
+- Broadcasting to HLS
+
+## **Repo Overview** 😎
+This repo contains projects and samples developed by the team and Stream community. 
+Projects are broken up into directories containing the source code for each project.
+
+## **Projects/Packages 🚀**
+The React Native SDK is a part of the Stream Video JS monorepo. 
+The monorepo consists of multiple folders, the most important of which are `packages` and `sample-apps`.
+- The `packages` folder contains the packages each of which is a separate npm package. The React Native SDK is one of the packages alongside:
+  - Our shared JS Call Engine (`client`).
+  - React Bindings (`react-bindings`).
+  - React SDK (`react-sdk`).
+  
+- The `sample-apps` folder contains the sample apps that are built using the packages from the `packages` folder. 
+React Native's most relevant sample app is the `dogfooding` app which is a complete app that implements most of the features of the SDK.
+
+- The `react-native-sdk/docusaurus` folder contains the documentation and guides.
+
+
+## **Requirements** 🛠
+Before running this project please ensure you have set up your development environment for React Native. 
+The Stream Video React Native SDK supports apps created with the React Native CLI.
+Apps created with Expo are currently not officially supported.
+
+
+## **Contributing** 🤝
+- How can I submit a sample app?
+    - Apps submissions are always welcomed 🥳 Open a pr with a proper description and we'll review it as soon as possible
+- Spot a bug 🕷 ?
+    - We welcome code changes that improve the apps or fix a problem. Please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github.
+
+---
+## Roadmap
+Stream's video roadmap and changelog are available [here](https://github.com/GetStream/protocol/discussions/127). 
+
+### Remaining 0.1 items
+- [ ] Push notifications
+- [ ] Reconnection
+- [ ] Simulcasting (works on Android, iOS is WIP)
+- [ ] Components alignment and refactor
+- [ ] UI Component documentation
+- [ ] Chat integration guide
+- [ ] Pinning and spotlight participants
+
+### 0.2 milestone
+- [ ] Livestream tutorial
+- [ ] Audio Rooms tutorial
+- [ ] Deeplink support for video call demo (Dogfooding already implemented)
+- [ ] Speaking while muted
+- [ ] Landscape support
+- [ ] Call Analytics
+
+### 0.3 milestone
+- [ ] Stability
+- [ ] Test with a large call with many participants
+- [ ] Test coverage
+- [ ] CPU usage improvements
+- [ ] Picture-in-Picture
+- [ ] Dynascale 2.0 (codecs, f resolution switches, resolution webrtc handling)
+
+### 0.4 milestone
+- [ ] Audio & Video filters
+- [ ] Screen sharing from mobile
+- [ ] Tap to focus
+- [ ] Analytics integration
+- [ ] Picture of the video stream at highest resolution

package/package.json

@@ -66,5 +66,5 @@
     "typedoc-plugin-markdown": "^3.15.3",
     "typescript": "^4.9.5"
   },
-  "version": "0.0.1-alpha.169"
+  "version": "0.0.1-alpha.170"
 }