mirror of
https://github.com/seigler/HLS-over-IPFS-video-player
synced 2025-07-26 01:06:15 +00:00
improve gitignore & readme
This commit is contained in:
parent
40b0a6943c
commit
a7af1fc03a
2 changed files with 16 additions and 4 deletions
7
.gitignore
vendored
7
.gitignore
vendored
|
@ -1,3 +1,4 @@
|
|||
node_modules
|
||||
.parcel-cache
|
||||
dist/
|
||||
node_modules/
|
||||
dist/
|
||||
.cache/
|
||||
.parcel-cache/
|
||||
|
|
13
README.md
13
README.md
|
@ -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.
|
||||
|
||||
## How to use
|
||||
|
||||
Accepts three query parameters:
|
||||
|
||||
- `hash`: required. The IPFS hash of a folder containing an HLS playlist and its files.
|
||||
|
@ -19,4 +21,13 @@ The output from the `ipfs` command is the hash to use with this page.
|
|||
|
||||
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue