README: add demo link, fix tagline, Windows server option, demo mode, PWA/HTTPS note, hosting section
This commit is contained in:
@@ -2,18 +2,30 @@
|
||||
|
||||
A personal MTV-style music video TV channel that runs entirely in your browser. Add YouTube playlists as channels, flip between them like cable TV, and let it run in the background. Late 90s / TRL-era aesthetic.
|
||||
|
||||
**One file. No build step. No server required.**
|
||||
**One file. No build step. No backend.**
|
||||
|
||||
---
|
||||
|
||||
## Demo
|
||||
|
||||
Try it live: **[ffazeshift.net/vidflow](https://ffazeshift.net/vidflow/)**
|
||||
|
||||
No sign-up needed — you can explore in demo mode without an API key, or bring your own to add channels.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Option A — Open locally (simplest)
|
||||
### Option A — Open locally
|
||||
|
||||
YouTube's IFrame API requires an HTTP origin, so you can't just double-click the file. Serve it with Python:
|
||||
YouTube's IFrame API requires an HTTP origin, so you can't just double-click the file. Serve it with any local server:
|
||||
|
||||
```bash
|
||||
# Python (usually pre-installed on Mac/Linux)
|
||||
python3 -m http.server 8080
|
||||
|
||||
# Node (no install needed if you have Node)
|
||||
npx serve .
|
||||
```
|
||||
|
||||
Then open **http://localhost:8080/vidflow.html**
|
||||
@@ -26,7 +38,7 @@ Upload `vidflow.html` to any static host — GitHub Pages, Netlify, Cloudflare P
|
||||
|
||||
## First-time Setup
|
||||
|
||||
VidFlow will walk you through two things on first launch:
|
||||
VidFlow will walk you through two things on first launch. Not ready to commit? Hit the **demo mode** link on the setup screen to try it first.
|
||||
|
||||
### 1. YouTube Data API key
|
||||
|
||||
@@ -59,7 +71,7 @@ Add a few channels and you're watching.
|
||||
| **Pop-out player** | Detach into a small floating window (shares your channels) |
|
||||
| **Shuffle** | On by default — plays a random video from the playlist |
|
||||
| **Now playing** | Artist + title ticker scrolls across the bottom |
|
||||
| **PWA** | Add to home screen on mobile for a full-screen TV experience |
|
||||
| **PWA** | Add to home screen on mobile for a full-screen TV experience (requires HTTPS) |
|
||||
|
||||
### Keyboard shortcuts
|
||||
|
||||
@@ -74,11 +86,11 @@ Add a few channels and you're watching.
|
||||
|
||||
---
|
||||
|
||||
## Hosting on Gitea / GitHub Pages
|
||||
## Hosting
|
||||
|
||||
Since VidFlow is a single HTML file, deploying is just copying the file:
|
||||
|
||||
**GitHub Pages**: push to a repo, enable Pages from the repo settings, visit `https://yourusername.github.io/vidflow/vidflow.html`
|
||||
**GitHub Pages / Gitea Pages**: push to a repo, enable Pages from the repo settings.
|
||||
|
||||
**Any static host**: upload `vidflow.html` — done.
|
||||
|
||||
@@ -118,4 +130,4 @@ If you'd rather watch without ads, any browser-level adblocker will handle it
|
||||
|
||||
- A modern browser (Chrome, Firefox, Safari, Edge)
|
||||
- A YouTube Data API v3 key (free tier is plenty for personal use)
|
||||
- An HTTP server for local use (Python's built-in one works great)
|
||||
- A local HTTP server for local use — Python or Node both work (see Quick Start)
|
||||
|
||||
Reference in New Issue
Block a user