openvibers/openvibe.search Commits

README first screen and CITATION.cff (#268)

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

Changes

ddiff --git a/CITATION.cff b/CITATION.cff
nnew file mode 100644
iindex 0000000..7406afc
---- /dev/null
++++ b/CITATION.cff
@@@ -0,0 +1,18 @@
++cff-version: 1.2.0
++message: "If you use OpenVibe.Search in research or a product, cite it as below."
++title: openvibe-search
++type: software
++authors:
++  - name: OpenVibe
++    alias: OpenVibers
++    website: https://openvibe.network
++repository-code: https://github.com/OpenVibers/OpenVibe.Search
++url: https://openvibe.network
++license: AGPL-3.0-only
++abstract: "A permission-aware search index for the OpenVibe network: ACL-filtered queries and deletion propagation."
++keywords:
++  - openvibe
++  - acl
++  - full-text-search
++  - indexing
++  - nodejs
ddiff --git a/README.md b/README.md
iindex 3ac2387..7eb58ed 100644
---- a/README.md
++++ b/README.md
@@@ -3,6 +3,9 @@
  > Permission-aware discovery for the network: the canonical index document, event-fed indexing,
  > an ACL-filtered query API, and deletion/visibility propagation.
  
++**Docs:** https://openvibe.services · **For AI:** https://openvibe.network/llms.txt
++**Run it:** `npm ci && npm run dev` (Node 22 or newer) · **Tests:** `npm test`
++
  **Status:** alpha (roadmap Wave 14). Runs on the production host (127.0.0.1:4710, since 2026-09-23)
  and is fed through Events; on 2026-10-10 the index held, per the plan record, 1976 work jobs, 51 help articles and 70 inventory items (2097 documents) plus wiki tombstones; how many are public was not measured.  
  **Domain:** `search.openvibe.network`, served by this repository's vhost