openvibers/openvibe.connect Commits

README first screen and CITATION.cff (#98)

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

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..d812a94
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenVibe.Connect in research or a product, cite it as below."
++title: openvibe-connect
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenVibe.Connect
++url: https://connect.openvibe.link
++license: AGPL-3.0-only
++abstract: "Share one local port at <name>--<you>.openvibe.link behind OpenVibe sign-in, at connect.openvibe.link."
++keywords:
++  - openvibe
++  - localhost
++  - networking
++  - reverse-proxy
++  - security
ddiff --git a/README.md b/README.md
iindex b0fff87..1b080e3 100644
---- a/README.md
++++ b/README.md
@@@ -3,6 +3,9 @@
  OpenVibe Connect lives at `connect.openvibe.link`; the old `.openvibe.website` addresses still work and redirect. See
  [the staged rollout and host commands](docs/link-share-rollout.md) for how the move was deployed.
  
++**Live site:** https://connect.openvibe.link · **API docs:** https://openvibe.services · **For AI:** https://connect.openvibe.link/llms.txt
++**Run it:** `npm ci && npm run dev` (Node 22 or newer) · **Tests:** `npm test`
++
  **Your computer, on the web, privately.** Share one port on your computer at its own HTTPS address,
  `https://<name>--<you>.openvibe.link`, and only the people you pick can open it, signed in with OpenVibe. No router
  settings, no open ports, no app to install: one file and Link.