From e847cf2117ccca58c9c814feb2bf7b9d07c9ef38 Mon Sep 17 00:00:00 2001 From: Matt Gros <3311227+mpge@users.noreply.github.com> Date: Sun, 5 Apr 2026 23:31:13 -0400 Subject: [PATCH] docs: improve README content and formatting Adds License badge, links to escalated.dev, related packages section, and License section. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6958ef3..eb3a84a 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ [![Tests](https://github.com/escalated-dev/escalated-plugin-sdk/actions/workflows/run-tests.yml/badge.svg)](https://github.com/escalated-dev/escalated-plugin-sdk/actions/workflows/run-tests.yml) [![Node.js](https://img.shields.io/badge/node.js-20+-339933?logo=node.js&logoColor=white)](https://nodejs.org/) [![TypeScript](https://img.shields.io/badge/typescript-5.x-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -SDK for building Escalated plugins. Write plugins once in TypeScript, run them across all Escalated backend frameworks (Laravel, Django, AdonisJS, Rails). +SDK for building [Escalated](https://escalated.dev) plugins. Write plugins once in TypeScript, run them across all Escalated backend frameworks (Laravel, Django, AdonisJS, Rails). ## Quick Start @@ -160,7 +161,17 @@ definePlugin({ See the [Escalated Docs](https://github.com/escalated-dev/escalated-docs) for the full plugin development guide. +## Related Packages + +- **[Plugin Runtime](https://github.com/escalated-dev/escalated-plugin-runtime)** — Runtime host that loads and executes plugins +- **[Escalated](https://github.com/escalated-dev/escalated)** — Shared frontend (Vue 3 + Inertia.js) +- **[Escalated Docs](https://github.com/escalated-dev/escalated-docs)** — Full documentation + ## Requirements - Node.js >= 18 - TypeScript >= 5.4 + +## License + +MIT