@webex/internal-media-core 0.0.1-beta

package/README.md

@@ -0,0 +1,80 @@
+![Logo of the project](https://avatars.githubusercontent.com/u/15900782?s=100&v=4)
+# webrtc-media-core
+
+> A framework for interacting with WebRTC across multiple browsers.
+
+> https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Webrtc+Media+Core+Framework
+
+ 
+## Developing
+
+```shell
+git clone https://sqbu-github.cisco.com/WebExSquared/webrtc-media-core
+cd webrtc-media-core/
+yarn install
+```
+
+### Building
+
+If your project needs some additional steps for the developer to build the
+project after some code changes, state them here:
+
+```shell
+yarn build
+```
+
+### Testing
+
+```shell
+yarn test
+```
+
+### Testing in debug mode
+
+```shell
+yarn test:debug
+```
+
+1.	After the above command, open up http://localhost:9876/debug.html in browser and do inspect element. (Note - HTTP & not HTTPS)
+1.	Here, the test files would be available in sources tab, where debuggers can be set and refresh the page to run tests again.
+1.	It also looks out for changes. So, whenever the test file changes, the test cases re-run in terminal and latest changes reflect in debug.html upon page refresh.
+
+### Integration Testing
+
+```shell
+yarn run test:integration
+```
+
+### Integration Testing with Sauce Labs
+
+1. Add ```.env``` file in your project.
+```shell
+#.env
+# Update your SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables below
+SAUCE_USERNAME="YOUR_SAUCE_USERNAME"
+SAUCE_ACCESS_KEY="YOUR_SAUCE_ACCESS_KEY"
+```
+2. Make sure your `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables are set in ```.env``` file.
+
+`SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` are credentials from your [SauceLabs account](https://docs.saucelabs.com/basics/environment-variables/)
+
+3. Run the below command in the terminal.
+```shell
+SAUCE=true yarn run test:integration
+```
+4. Sauce labs link in the results or Open your Sauce labs and filter test with your name and see the test case.
+
+### Deploying / Publishing
+
+In case there's some step you have to take that publishes this project to a
+server, this is the right time to state it.
+
+```shell
+yarn release
+```
+
+### Contribute
+
+Thank you for considering contributing to this repository!
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details about testing, building the packages
+and submitting pull requests for suggested changes. Pull requests welcome.