README first screen and CITATION.cff (#262)

OP OpenVibers committed 3 days ago · 52bb4bca75 · 2 files, +21 −0

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..5751d56
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenRestream in research or a product, cite it as below."
++title: openre-stream
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenRestream
++url: https://openre.stream
++license: AGPL-3.0-only
++abstract: "Restream once to every platform from OBS or a browser, with OpenVibe.Live on by default, at openre.stream."
++keywords:
++  - openvibe
++  - nodejs
++  - self-hosted
++  - video
++  - streaming
ddiff --git a/README.md b/README.md
iindex fea5abf..7173556 100644
---- a/README.md
++++ b/README.md
@@@ -4,6 +4,9 @@
  > any RTMP, RTMPS or SRT server at the same time, with OpenVibe Live on by default. Underneath: stream definitions,
  > keys, sessions, transport workers, outputs and output health.
  
++**Live site:** https://openre.stream · **API docs:** https://openvibe.services · **For AI:** https://openre.stream/llms.txt
++**Run it:** `npm ci && npm run dev` (Node 22.12 or newer) · **Tests:** `npm test`
++
  **Status:** alpha (roadmap Wave 7). Tested end to end with real RTMP. Deployed internally on `openvibe-ovh` since 2026-09-23 (API and coordinator on 127.0.0.1:4500; RTMP ingest public on port 1936 at `ingest.openre.stream` since the cutover runbook's phase A on 2026-09-23; Live wired with `OPENRE_URL` and an `openre.session.*` subscription; one rehearsal broadcast passed). **openre.stream serves its own site since 2026-10-09** (plan T11, cutover step B0 (a)): sign in with OpenVibe, create a stream with its RTMP key, and send it to other channels. No Live slot is ingested here yet: every slot is still ingested by Live until its per-slot cutover (`docs/cutover.md` phase B).
  **Domain:** `openre.stream` (UI + API), `ingest.openre.stream` (RTMP, DNS only)
  **Plan:** OpenVibe End-to-End Realignment & Implementation Plan, revision 3 (20 Sep 2026), §10, §10.5, §15.10; ADR-009 (binding), ADR-004, ADR-006, ADR-007.

diff --git a/CITATION.cff b/CITATION.cff

new file mode 100644

index 0000000..5751d56

--- /dev/null

+++ b/CITATION.cff

@@ -0,0 +1,18 @@

+cff-version: 1.2.0

+message: "If you use OpenRestream in research or a product, cite it as below."

+title: openre-stream

+type: software

+authors:

+ - name: OpenVibe

+ alias: OpenVibers

+ website: https://openvibe.network

+repository-code: https://github.com/OpenVibers/OpenRestream

+url: https://openre.stream

+license: AGPL-3.0-only

+abstract: "Restream once to every platform from OBS or a browser, with OpenVibe.Live on by default, at openre.stream."

+keywords:

+ - openvibe

+ - nodejs

+ - self-hosted

+ - video

+ - streaming

diff --git a/README.md b/README.md

index fea5abf..7173556 100644

--- a/README.md

+++ b/README.md

@@ -4,6 +4,9 @@

> any RTMP, RTMPS or SRT server at the same time, with OpenVibe Live on by default. Underneath: stream definitions,

> keys, sessions, transport workers, outputs and output health.

+**Live site:** https://openre.stream · **API docs:** https://openvibe.services · **For AI:** https://openre.stream/llms.txt

+**Run it:** `npm ci && npm run dev` (Node 22.12 or newer) · **Tests:** `npm test`

**Status:** alpha (roadmap Wave 7). Tested end to end with real RTMP. Deployed internally on `openvibe-ovh` since 2026-09-23 (API and coordinator on 127.0.0.1:4500; RTMP ingest public on port 1936 at `ingest.openre.stream` since the cutover runbook's phase A on 2026-09-23; Live wired with `OPENRE_URL` and an `openre.session.*` subscription; one rehearsal broadcast passed). **openre.stream serves its own site since 2026-10-09** (plan T11, cutover step B0 (a)): sign in with OpenVibe, create a stream with its RTMP key, and send it to other channels. No Live slot is ingested here yet: every slot is still ingested by Live until its per-slot cutover (`docs/cutover.md` phase B).

**Domain:** `openre.stream` (UI + API), `ingest.openre.stream` (RTMP, DNS only)

**Plan:** OpenVibe End-to-End Realignment & Implementation Plan, revision 3 (20 Sep 2026), §10, §10.5, §15.10; ADR-009 (binding), ADR-004, ADR-006, ADR-007.