From d66cb10aa8ee4fe91e452ad9d7a5e85f2182fab3 Mon Sep 17 00:00:00 2001 From: Antony Rizzitelli Date: Thu, 12 Nov 2026 13:25:15 +0000 Subject: [PATCH] docs(readme): adopt the AntelopeJS framework README style --- .github/readme/strip.svg | 1 + README.md | 18 ++++++++++++++---- package.json | 2 +- pnpm-lock.yaml | 10 +++++----- 4 files changed, 21 insertions(+), 10 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..26ee066 --- /dev/null +++ b/.github/readme/strip.svg @@ -0,0 +1 @@ +TEMPLATE · MODULE TYPESCRIPT: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.TEMPLATE · MODULE TYPESCRIPTPart of AntelopeJSHexagonal architecture, beyond your own code.★ Star AntelopeJS \ No newline at end of file diff --git a/README.md b/README.md index 647fc13..0aa5893 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ -# AntelopeJS module TypeScript template +TEMPLATE · MODULE TYPESCRIPT: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.
-License -Discord -Documentation + +# AntelopeJS module TypeScript template + +License Discord Documentation Star AntelopeJS + +**Template for an AntelopeJS module that defines an interface and implements it, with a playground project that calls it.** + +[Documentation](https://framework.antelopejs.com/docs/module-development/creating-a-module) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem) +
A starter for a module that defines an AntelopeJS interface and implements it, with a playground project that calls it. @@ -82,6 +88,10 @@ Using Claude Code or Codex? Install the [AntelopeJS agent skills plugin](https:/ See [CONTRIBUTING.md](./CONTRIBUTING.md). Run `pnpm install` then `pnpm run checks` before you open a pull request. +## Part of AntelopeJS + +This template 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) diff --git a/package.json b/package.json index 2bbf419..faae116 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ }, "devDependencies": { "@antelopejs/core": "^1.21.3", - "@antelopejs/tooling-configs": "^0.5.4", + "@antelopejs/tooling-configs": "^0.5.5", "@types/mocha": "^10.0.10", "@types/node": "^22.19.15", "knip": "^6.34.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 86bf98f..963dbeb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -16,8 +16,8 @@ importers: specifier: ^1.21.3 version: 1.21.3 '@antelopejs/tooling-configs': - specifier: ^0.5.4 - version: 0.5.4(knip@6.43.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2005)) + specifier: ^0.5.5 + version: 0.5.5(knip@6.43.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2005)) '@types/mocha': specifier: ^10.0.10 version: 10.0.10 @@ -56,8 +56,8 @@ packages: '@antelopejs/interface-core@0.4.1': resolution: {integrity: sha512-6UZWBp4IXHUNqP26uaqG+kmDfJW79LvPpskITmoouv57zsZ0RgyCLfc0sHs7Bcj/88hvhy/KLYgQ51p11IlBjQ==} - '@antelopejs/tooling-configs@0.5.4': - resolution: {integrity: sha512-WcprlpQt0+IGAiJ558aZv8Mxfl75hY0fI8v42jN1bBYsQCAJT8SdoJiIN3J90Sp0AdrJcOZy1o0tqRuxJ7duyA==} + '@antelopejs/tooling-configs@0.5.5': + resolution: {integrity: sha512-03QagBC3hE4GAtEF+vwEYWvQfD1oqik+3OrvzT6MaII88vwHdWJOiyqUcHW0ul+ujG4GBL5nDO+wmBciTxQB+g==} engines: {node: '>=22.18.0'} hasBin: true peerDependencies: @@ -1328,7 +1328,7 @@ snapshots: dependencies: reflect-metadata: 0.2.2 - '@antelopejs/tooling-configs@0.5.4(knip@6.43.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2005))': + '@antelopejs/tooling-configs@0.5.5(knip@6.43.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2005))': dependencies: '@oxlint/plugins': 1.81.0 dts-bundle-generator: 9.5.1