diff --git a/README.md b/README.md index 327ba82..4d0d155 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,18 @@ import { BigBlueButtonMobile } from "bigbluebutton-mobile-sdk"; /> ``` +## Architecture + +This SDK (in combination with bigbluebutton-html5 code tweaks) implements replacement functions to navigator and WebRTC functions. + +### getDisplayMedia + +The following sequence diagram represents what happens when BigBlueButton calls the `navigator.getDisplayMedia` function: + +![getDisplayMedia sequence diagram](/docs/uml/ios-screenshare/exported/BigBlueButton Mobile screenshare.svg "getDisplayMedia sequence diagram") + + + ## Contributing See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.