Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add examples to README #69

Open
mazz opened this issue Dec 8, 2018 · 0 comments
Open

Add examples to README #69

mazz opened this issue Dec 8, 2018 · 0 comments

Comments

@mazz
Copy link

mazz commented Dec 8, 2018

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

@benhylau benhylau added this to the OurNetworks 2019 milestone Apr 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants