Skip to content

docs: point app authors at the runner template #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickstaa merged 1 commit into from
Aug 17, 2026
Merged

docs: point app authors at the runner template #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<app>-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 `<app>-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

Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<app>-livepeer-runner` (e.g. `comfyui-livepeer-runner`).
- Add the `livepeer-runner` GitHub topic.
Expand Down
Loading