openvibers/openvibe.examples Commits

README first screen and CITATION.cff (#104)

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

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..fa248ee
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenVibe.Examples in research or a product, cite it as below."
++title: openvibe-examples
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenVibe.Examples
++url: https://openvibe.services
++license: MIT
++abstract: "Executable, CI-tested examples for building on the OpenVibe platform: auth, APIs, webhooks and the SDK."
++keywords:
++  - openvibe
++  - api
++  - examples
++  - javascript
++  - oauth
ddiff --git a/README.md b/README.md
iindex b2e64c2..396f8fb 100644
---- a/README.md
++++ b/README.md
@@@ -3,6 +3,9 @@
  > Executable public integration examples for the OpenVibe platform: the SDK, scoped credentials
  > and public APIs, nothing else.
  
++**Docs:** https://openvibe.services · **For AI:** https://openvibe.services/llms.txt
++**Install and test:** `npm ci && npm test` (Node 22 or newer)
++
  **Status:** alpha, 0.3.0 (roadmap Wave 20; the `create-openvibe-app` scaffolder, WS-N task 6). Eighteen examples, each with a smoke test that CI runs on
  Node 22.22.1 against `openvibe-sdk/testing`'s mock platform (no network). `npm run e2e` runs three
  of them (Media, Events pull, a Tools job) against the real platform with your own sandbox app; it