openvibers/openvibe.help Commits

README first screen and CITATION.cff (#253)

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

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..5c36892
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenVibe.Help in research or a product, cite it as below."
++title: openvibe-help
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenVibe.Help
++url: https://openvibe.help
++license: AGPL-3.0-only
++abstract: "Help for every OpenVibe site, with a ticket to a person when the answer is not there, at openvibe.help."
++keywords:
++  - openvibe
++  - documentation
++  - faq
++  - help-center
++  - support
ddiff --git a/README.md b/README.md
iindex 27b311b..fb1b428 100644
---- a/README.md
++++ b/README.md
@@@ -2,6 +2,9 @@
  
  > Answers, support and a way to reach people.
  
++**Live site:** https://openvibe.help · **API docs:** https://openvibe.services · **For AI:** https://openvibe.help/llms.txt
++**Run it:** `npm ci && npm run dev` (Node 22 or newer) · **Tests:** `npm test`
++
  **Status:** the product is written, tested and deployed (see [STATUS.json](STATUS.json)).
  **Domain:** `openvibe.help` · **Port:** 5020 · **Service id:** `help` · **Env prefix:** `HELP`
  **License:** AGPL-3.0 (same as every OpenVibe service).