ipfs-live-streaming icon indicating copy to clipboard operation
ipfs-live-streaming copied to clipboard

Add examples to README

Open mazz opened this issue 6 years ago • 0 comments

Examples of the different ways to access ipfs resources would be helpful.

i.e. the README has the params needed for different settings, which is good:

Parameter | Description
-- | --
gw | Set IPFS gateway URL to override playback gateway
live | Set m3u8 file URL to override IPFS live stream
vod | Set IPFS content hash of mp4 file to play IPFS on-demand video stream

An improvement would be to show the usage also i.e.

https://mysite.com/?vod=QmPk33q8z8GHhJoDKXGDGn5CWFu61TzTprgupfGe4VNwho

also, a clarification of when to use a gateway would be helpful, because for live streams it appears that a gateway is required but for vod it's not required:

https://mysite.com/?live=https://ipfs.io/ipns/QmZQeeZUCX1boerKc8VH42JRoXDNys1XCgVYnPd18EQtDT

mazz avatar Dec 08 '18 20:12 mazz