From a7af1fc03a866da7ce96ea1e6d48d64451b75a38 Mon Sep 17 00:00:00 2001 From: Joshua Seigler Date: Wed, 24 Nov 2021 16:24:13 -0500 Subject: [PATCH] improve gitignore & readme --- .gitignore | 7 ++++--- README.md | 13 ++++++++++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 04c9e4c..b833cb9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -node_modules -.parcel-cache -dist/ \ No newline at end of file +node_modules/ +dist/ +.cache/ +.parcel-cache/ diff --git a/README.md b/README.md index 33e9150..57890a2 100644 --- a/README.md +++ b/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 \ No newline at end of file +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