Skip to content

Commit 565ee4f

Browse files
Be more clear about limitations in different modes
1 parent a537e6c commit 565ee4f

2 files changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Create, annotate, and remix interactive videos on the web.
66

77
FrameTrail is an open-source platform for building non-linear, interactive video experiences. Add overlays, annotations, video links, and code snippets to any video — or create time-based presentations without video at all. All data is stored as portable JSON files with no database required.
88

9-
**No server required for viewing or editing.** FrameTrail runs entirely in the browser using the [File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) for local file editing, or with an Apache+PHP backend for multi-user collaboration. It also works in any browser — including Firefox and Safari — via an in-memory mode where edits can be exported as JSON.
9+
FrameTrail works in three modes with different capabilities. A PHP backend provides the full feature set: multi-user accounts, collaborative editing, file uploads, and optional media processing. In Chrome/Edge, the [File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) enables single-user local editing with file uploads, but without transcoding or user management. In any browser — including Firefox and Safari — an in-memory mode lets you view and edit contents and export changes as JSON.
1010

1111
---
1212

1313
## Features
1414

1515
### Three Ways to Run
1616

17-
1. **Server mode** (Apache + PHP) — Full multi-user editing, file uploads, user management
18-
2. **Local folder mode** (Chrome/Edge) — Full editing without a server, using the File System Access API to read/write a local `_data` folder
19-
3. **In-memory mode** (all browsers) — Pass hypervideo data via init options; view and edit in-browser; export changes as JSON via Save As. Nothing persists past a page reload unless exported. Works in Firefox, Safari, and everywhere else.
17+
1. **Server mode** (Apache + PHP) — Multi-user accounts, collaborative editing, file uploads, optional media transcoding and thumbnail generation
18+
2. **Local folder mode** (Chrome/Edge) — Single-user editing saved directly to a local `_data` folder via the File System Access API; file uploads supported, no transcoding or user management
19+
3. **In-memory mode** (all browsers) — View and edit in-browser; export changes as JSON via Save As; no file uploads; requires content to be passed via init options. Works in Firefox, Safari, and everywhere else.
2020

2121
### Editing
2222

docs/DEPLOYMENT.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Then open `http://localhost:8080`. No Apache, no XAMPP needed if PHP is installe
4343

4444
### Option 2: Local Folder Mode (No Server)
4545

46-
Full editing without a server. Uses the [File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) to read and write files directly on disk.
46+
Single-user editing without a server. Uses the [File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) to read and write files directly on disk. File uploads (images, video, audio) are supported, but server-side capabilities like media transcoding, thumbnail generation, and user management are not available.
4747

4848
**Requirements:**
4949
- Chrome or Edge (the File System Access API is not supported in Firefox or Safari)
@@ -54,15 +54,16 @@ Full editing without a server. Uses the [File System Access API](https://develop
5454
2. Open `index.html` directly in Chrome or Edge
5555
3. FrameTrail detects the local environment and prompts you to select a `_data` folder
5656
4. Select an existing `_data` folder or create a new empty folder
57-
5. Full editing is available — all changes are saved directly to the selected folder
57+
5. Editing is available — all changes are saved directly to the selected folder
5858

5959
**How it works:**
6060

6161
The `StorageAdapterLocal` class uses the File System Access API (`showDirectoryPicker`, `FileSystemDirectoryHandle`, etc.) to read and write JSON files and uploaded media. The browser asks for permission the first time you access a folder, then remembers it for the session.
6262

6363
**Limitations:**
6464
- Identity is name-only (a login dialog prompts for a display name before entering edit mode; no account or password required)
65-
- No PHP-based file processing (image optimization, video transcoding)
65+
- No media transcoding or thumbnail generation (no server-side processing)
66+
- No multi-user collaboration or shared resource library
6667
- Browser must support File System Access API (Chrome/Edge only)
6768

6869
### Option 3: In-Memory Mode (All Browsers)

0 commit comments

Comments
 (0)