README first screen and CITATION.cff (#289)

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

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..4afe3ff
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenVibe.Events in research or a product, cite it as below."
++title: openvibe-events
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenVibe.Events
++url: https://openvibe.events
++license: AGPL-3.0-only
++abstract: "Durable events, subscriptions, delivery, retry, dead letters and replay, at openvibe.events."
++keywords:
++  - openvibe
++  - events
++  - message-queue
++  - nodejs
++  - pubsub
ddiff --git a/README.md b/README.md
iindex 600d950..55f7de3 100644
---- a/README.md
++++ b/README.md
@@@ -2,6 +2,9 @@
  
  > Durable events, subscriptions, delivery, retry, dead letters and replay for the network.
  
++**Live site:** https://openvibe.events · **API docs:** https://openvibe.services · **For AI:** https://openvibe.events/llms.txt
++**Run it:** `npm ci && npm run dev` (Node 20 or newer) · **Tests:** `npm test`
++
  **Status:** alpha (roadmap Wave 3), deployed on `openvibe-ovh` (unit `openvibe-events`, 127.0.0.1:4300, public at `https://openvibe.events`). In the week to 2026-10-21, 28 of the network's services published to it in production (`events.source`; Search, Sources, Reviews, AI and Work the most), and seven developer apps sent events of their own; every consumer webhook requires signature v2. Media's completion events reach Live only through Events (`/internal/media-events`; Live's direct `/internal/media-webhook` was retired on 2026-10-10), and the shared notification bell can follow `network.notification.created` over the realtime stream with a Network ticket.  
  **Domain:** `openvibe.events` is the API and product origin (plan T7): the JSON API, the realtime gateway (ADR-005 put Realtime inside Events; `realtime.openvibe.network` has no runtime of its own), the home page and its `robots.txt`/`sitemap.xml`/`llms.txt`. The old `events.openvibe.network` address was retired on 2026-10-10.  
  **Plan:** OpenVibe End-to-End Realignment & Implementation Plan, revision 3 (20 Sep 2026), §6 and §6.3.

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

new file mode 100644

index 0000000..4afe3ff

--- /dev/null

+++ b/CITATION.cff

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

+cff-version: 1.2.0

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

+title: openvibe-events

+type: software

+authors:

+ - name: OpenVibe

+ alias: OpenVibers

+ website: https://openvibe.network

+repository-code: https://github.com/OpenVibers/OpenVibe.Events

+url: https://openvibe.events

+license: AGPL-3.0-only

+abstract: "Durable events, subscriptions, delivery, retry, dead letters and replay, at openvibe.events."

+keywords:

+ - openvibe

+ - events

+ - message-queue

+ - nodejs

+ - pubsub

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

index 600d950..55f7de3 100644

--- a/README.md

+++ b/README.md

@@ -2,6 +2,9 @@

> Durable events, subscriptions, delivery, retry, dead letters and replay for the network.

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

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

**Status:** alpha (roadmap Wave 3), deployed on `openvibe-ovh` (unit `openvibe-events`, 127.0.0.1:4300, public at `https://openvibe.events`). In the week to 2026-10-21, 28 of the network's services published to it in production (`events.source`; Search, Sources, Reviews, AI and Work the most), and seven developer apps sent events of their own; every consumer webhook requires signature v2. Media's completion events reach Live only through Events (`/internal/media-events`; Live's direct `/internal/media-webhook` was retired on 2026-10-10), and the shared notification bell can follow `network.notification.created` over the realtime stream with a Network ticket.

**Domain:** `openvibe.events` is the API and product origin (plan T7): the JSON API, the realtime gateway (ADR-005 put Realtime inside Events; `realtime.openvibe.network` has no runtime of its own), the home page and its `robots.txt`/`sitemap.xml`/`llms.txt`. The old `events.openvibe.network` address was retired on 2026-10-10.

**Plan:** OpenVibe End-to-End Realignment & Implementation Plan, revision 3 (20 Sep 2026), §6 and §6.3.