From c353b5ab12dd44934b9f58328a2b6df5e3c84147 Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Mon, 17 Aug 2026 10:24:11 +0200 Subject: [PATCH] docs: point app authors at the runner template The naming convention was documented but there was no working starting point, and the examples cannot serve as one: each compose.yml pulls the orchestrator from a shared file one directory up, so a copied example fails on the first `docker compose up`. Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01SD4o2Evku53Nb6zfgAdWxV --- CONTRIBUTING.md | 2 +- README.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bdbe4a..4d4a734 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Thank you for considering contributing to the live runner example apps. These ar This repo covers each value of the example axes (registration, mode, transport, pricing) once — it is not a collection of apps built on the runner. - **In scope** — bug fixes, doc improvements, and new examples that fill a gap in the README's axis table. Open an issue first to agree on the gap. -- **Out of scope** — new app examples that don't add axis coverage. Publish those in your own repo (name it `-livepeer-runner`, add the `livepeer-runner` GitHub topic, mention Livepeer in the description) and open a PR that adds one row to the README's [External examples](./README.md#external-examples) table. +- **Out of scope** — new app examples that don't add axis coverage. Publish those in your own repo and open a PR that adds one row to the README's [External examples](./README.md#external-examples) table. Start from [template-livepeer-runner](https://github.com/livepeer/template-livepeer-runner), which is self-contained and ships the naming convention as a checklist: name the repo `-livepeer-runner`, add the `livepeer-runner` GitHub topic, mention Livepeer in the description. Don't copy an example directory out of this repo — its `compose.yml` references shared files one level up and won't run on its own. ## Getting Started diff --git a/README.md b/README.md index 69c1555..b537136 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,9 @@ Apps that integrate the live runner and live in their own repos — production d | [livepeer/api-proxy](https://github.com/livepeer/api-proxy) | Attach several API endpoints dynamically — key storage and request stats for operators | HTTP | | [Gideonjon/vllm-realtime-livepeer-runner](https://github.com/Gideonjon/vllm-realtime-livepeer-runner) | Real-time speech-to-text — trickle audio in, WebSocket transcript out, with live metrics | WebSocket + trickle | -Built one? [Open a PR](https://github.com/livepeer/runner-app-examples/compare) that adds a row. To make your repo easy to find, follow the community convention: +**Building one?** Start from [**template-livepeer-runner**](https://github.com/livepeer/template-livepeer-runner) — a working app, client, and compose setup you can run in one command, offchain or on-chain. The examples here are not copyable as-is: each one's `compose.yml` pulls the orchestrator from a shared file one directory up. + +Then [open a PR](https://github.com/livepeer/runner-app-examples/compare) that adds a row. To make your repo easy to find, follow the community convention (the template's README walks through it): - Name the repo `-livepeer-runner` (e.g. `comfyui-livepeer-runner`). - Add the `livepeer-runner` GitHub topic.