awslabs / amazon-kinesis-video-streams-webrtc-sdk-js

JS SDK for interfacing with the Amazon Kinesis Video Streams Signaling Service.
https://awslabs.github.io/amazon-kinesis-video-streams-webrtc-sdk-js/examples/index.html
Apache License 2.0
286 stars 141 forks source link

Readme: Add more information about this repository #249

Closed sirknightj closed 1 year ago

sirknightj commented 1 year ago

What was changed?

The readme.

Why was it changed?

I saw a stackoverflow post https://stackoverflow.com/questions/75225256/get-live-video-from-amazon-kvs that found this repo and was confused about what this does. They were looking for a web viewer for the regular kinesis video streams, not kinesis video streams with webrtc.

How was it changed?

  1. Add a link to https://github.com/aws-samples/amazon-kinesis-video-streams-media-viewer
  2. Add the paragraph from the kvs with webrtc landing page. https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/what-is-kvswebrtc.html to hopefully differentiate this from the regular kinesis video streams.

Testing:

I read the modified part of the readme and checked out the preview.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.