From c40aa3a8bd9028ca1d8c4f1a33a37428cc1606f6 Mon Sep 17 00:00:00 2001 From: Antony Rizzitelli Date: Thu, 12 Nov 2026 13:25:58 +0000 Subject: [PATCH] docs(readme): adopt the AntelopeJS framework README style --- .github/readme/strip.svg | 1 + README.md | 20 ++++++++++++++------ 2 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 .github/readme/strip.svg diff --git a/.github/readme/strip.svg b/.github/readme/strip.svg new file mode 100644 index 0000000..2d69215 --- /dev/null +++ b/.github/readme/strip.svg @@ -0,0 +1 @@ +TOOLING · INTERFACE REGISTRY: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.TOOLING · INTERFACE REGISTRYPart of AntelopeJSHexagonal architecture, beyond your own code.★ Star AntelopeJS \ No newline at end of file diff --git a/README.md b/README.md index b51577d..a77b93f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# AntelopeJS interface registry +TOOLING · INTERFACE REGISTRY: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.
-License -Discord -Docs + +# AntelopeJS interface registry + +License Discord Documentation Star AntelopeJS + +**The interface registry the ajs CLI reads to find which modules implement an interface.** + +[Documentation](https://framework.antelopejs.com/docs/module-development/interface-registry) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem) +
The catalog the `ajs` CLI reads to find which modules implement an interface. It holds metadata only: the interface packages and their implementations live on npm. -Part of [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. Built by the team behind [AntelopeJS DMS](https://github.com/AntelopeJS/dms). - ## What it does - `ajs project modules install` finds the interfaces a project imports without an implementation, and offers the modules this registry lists for them. @@ -192,6 +196,10 @@ For a new interface, also map its package to the folder in the `interfaces` obje Read [CONTRIBUTING.md](./CONTRIBUTING.md), then open a pull request with your manifest change. +## Part of AntelopeJS + +This registry belongs to [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. The open-source back office [AntelopeJS DMS](https://github.com/AntelopeJS/dms) is built on it. + ## License [Apache-2.0](./LICENSE)