Ahoyapps 30 readme #38
Conversation
README.md
Outdated
|
|
||
| One great way to learn about the room object is to explore it in the browser console. When you are connected to a room, the application will expose the room object as a window variable: `window.twilioRoom`. | ||
|
|
||
| Since the `room` object maintains all state that relates to the connected room, it isn't necessary to use a tool like Redux to track the state of the room. We can instead use the `room` object as our source of truth. One caveat is that we will need some way of triggering component re-renders in React. The `room` object and most child properties are [event emitters](https://nodejs.org/api/events.html#events_class_eventemitter), which means that we can subscribe to these events to update React components as the room state changes. |
There was a problem hiding this comment.
What are your thoughts on replacing these sentences
Since the
roomobject maintains all state that relates to the connected room, it isn't necessary to use a tool like Redux to track the state of the room. We can instead use theroomobject as our source of truth. One caveat is that we will need some way of triggering component re-renders in React. Theroomobject and most child properties are event emitters, which means that we can subscribe to these events to update React components as the room state changes.
with the following:
The Twilio Video JS SDK manages the room object state. As a result, the room object itself serves as the source of truth and a tool like Redux is not needed to track room state. However, a caveat presents itself for React applications that need to trigger component re-renders. The room object and most child properties are event emitters, which means that a React application can subscribe to these events to update components as the room state changes.
There was a problem hiding this comment.
Went with something a little different here. What do you think?
Since the Twilio Video SDK manages the room object state, it can be used as the source of truth. It isn't necessary to use a tool like Redux to track the room state. The room object and most child properties are event emitters, which means that we can subscribe to these events to update React components as the room state changes.
CHANGELOG.md
Outdated
| @@ -1,13 +1,12 @@ | |||
| ## 0.1.0 | |||
|
|
|||
| This release marks the first iteration of the Twilio Video Collaboration App: a canonical multi-party collaboration video application built with Programmable Video. This application is intended to demonstrate the capabilities of Programmable Video and serve as a reference to developers building video apps. | |||
| This release marks the first iteration of the Twilio Video Collaboration App: a canonical multi-party collaboration video application built with Programmable Video. This application demonstrates the capabilities of Programmable Video and serve as a reference to developers building video apps. | |||
|
|
||
| ### `npm start` |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
timmydoza
dismissed stale reviews from aymenn and charliesantos
Changes have been applied -Aymen gave thumbs-up on slack
Contributing to Twilio
Pull Request Details
JIRA link(s):
Description
This PR adds a readme (to serve as a Getting Started guide) and a CHANGELOG.
Burndown
Before review
npm testBefore merge