joshua/HLS-over-IPFS-video-player
1
0
Fork 0
mirror of https://github.com/seigler/HLS-over-IPFS-video-player synced 2025-07-26 17:26:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve gitignore & readme

Browse source
This commit is contained in:
Joshua Seigler 2021-11-24 16:24:13 -05:00
parent 40b0a6943c
commit a7af1fc03a
2 changed files with 16 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.gitignore vendored
View file

@ -1,3 +1,4 @@
node_modules node_modules/
.parcel-cache
dist/ dist/
.cache/
.parcel-cache/

11
README.md
View file

@ -1,5 +1,7 @@
Based heavily on the [browser video streaming](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/browser-video-streaming) example from JS-IPFS. Based heavily on the [browser video streaming](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/browser-video-streaming) example from JS-IPFS.
## How to use
Accepts three query parameters: Accepts three query parameters:
- `hash`: required. The IPFS hash of a folder containing an HLS playlist and its files. - `hash`: required. The IPFS hash of a folder containing an HLS playlist and its files.
@ -20,3 +22,12 @@ The output from the `ipfs` command is the hash to use with this page.
Example URL: Example URL:
http://ipfs.io/ipfs/Qma8m84bDQGfSPEZreNg4ZKKTXJAbcFsrkcjgajGmXkXjs/index.html?hash=QmdpAidwAsBGptFB3b6A9Pyi5coEbgjHrL3K2Qrsutmj9K&title=Big%20Buck%20Bunny http://ipfs.io/ipfs/Qma8m84bDQGfSPEZreNg4ZKKTXJAbcFsrkcjgajGmXkXjs/index.html?hash=QmdpAidwAsBGptFB3b6A9Pyi5coEbgjHrL3K2Qrsutmj9K&title=Big%20Buck%20Bunny
## How to build from source
### NPM commands
- start: alias, _serve_
- serve: run & navigate to a live-build server on localhost port 8888
- build: build & output to output folder dist (overwrites, doesn't delete)
- clean: remove caches and dist folder