Improve generated README for new EventCatalog projects (#2385)

boyney123 · claude · web-flow · commit cb40037ee378 · 2026-03-24T10:18:58.000Z
Co-authored-by: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/.changeset/bright-clouds-dance.md b/.changeset/bright-clouds-dance.md
@@ -0,0 +1,5 @@
+---
+"@eventcatalog/create-eventcatalog": patch
+---
+
+Improve generated README with getting started guide, AI tools, integrations, and learning resources
diff --git a/packages/create-eventcatalog/templates/asyncapi/README-template.md b/packages/create-eventcatalog/templates/asyncapi/README-template.md
@@ -1 +1,55 @@
 # My Event Catalog
+
+Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
+
+## Getting Started
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your catalog.
+
+You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
+
+## What Can You Do?
+
+- **Document services** — define producers and consumers with their schemas
+- **Map events, commands & queries** — capture every message flowing through your system
+- **Organize with domains** — group resources into bounded contexts
+- **Visualize your architecture** — auto-generated diagrams of your services and message flows
+- **Version everything** — track how your architecture evolves over time
+- **Use AI to explore & document** — connect AI tools directly to your catalog
+
+## Use AI with Your Catalog
+
+### Skills
+
+Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
+
+```sh
+npx skills add event-catalog/skills
+```
+
+Skills can generate service documentation, create domain models, and map business flows — all through natural language.
+
+### MCP Server
+
+Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
+
+## Learn More
+
+- [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
+- [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
+- [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
+- [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
+- [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
+- [Discord](https://discord.gg/3rjaZMmrAm) — join the community
+
+## Found a problem?
+
+Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
diff --git a/packages/create-eventcatalog/templates/default/README-template.md b/packages/create-eventcatalog/templates/default/README-template.md
@@ -1 +1,55 @@
 # My Event Catalog
+
+Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
+
+## Getting Started
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your catalog.
+
+You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
+
+## What Can You Do?
+
+- **Document services** — define producers and consumers with their schemas
+- **Map events, commands & queries** — capture every message flowing through your system
+- **Organize with domains** — group resources into bounded contexts
+- **Visualize your architecture** — auto-generated diagrams of your services and message flows
+- **Version everything** — track how your architecture evolves over time
+- **Use AI to explore & document** — connect AI tools directly to your catalog
+
+## Use AI with Your Catalog
+
+### Skills
+
+Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
+
+```sh
+npx skills add event-catalog/skills
+```
+
+Skills can generate service documentation, create domain models, and map business flows — all through natural language.
+
+### MCP Server
+
+Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
+
+## Learn More
+
+- [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
+- [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
+- [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
+- [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
+- [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
+- [Discord](https://discord.gg/3rjaZMmrAm) — join the community
+
+## Found a problem?
+
+Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
diff --git a/packages/create-eventcatalog/templates/empty/README-template.md b/packages/create-eventcatalog/templates/empty/README-template.md
@@ -1 +1,55 @@
 # My Event Catalog
+
+Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
+
+## Getting Started
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your catalog.
+
+You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
+
+## What Can You Do?
+
+- **Document services** — define producers and consumers with their schemas
+- **Map events, commands & queries** — capture every message flowing through your system
+- **Organize with domains** — group resources into bounded contexts
+- **Visualize your architecture** — auto-generated diagrams of your services and message flows
+- **Version everything** — track how your architecture evolves over time
+- **Use AI to explore & document** — connect AI tools directly to your catalog
+
+## Use AI with Your Catalog
+
+### Skills
+
+Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
+
+```sh
+npx skills add event-catalog/skills
+```
+
+Skills can generate service documentation, create domain models, and map business flows — all through natural language.
+
+### MCP Server
+
+Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
+
+## Learn More
+
+- [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
+- [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
+- [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
+- [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
+- [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
+- [Discord](https://discord.gg/3rjaZMmrAm) — join the community
+
+## Found a problem?
+
+Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
diff --git a/packages/create-eventcatalog/templates/graphql/README-template.md b/packages/create-eventcatalog/templates/graphql/README-template.md
@@ -1 +1,55 @@
 # My Event Catalog
+
+Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
+
+## Getting Started
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your catalog.
+
+You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
+
+## What Can You Do?
+
+- **Document services** — define producers and consumers with their schemas
+- **Map events, commands & queries** — capture every message flowing through your system
+- **Organize with domains** — group resources into bounded contexts
+- **Visualize your architecture** — auto-generated diagrams of your services and message flows
+- **Version everything** — track how your architecture evolves over time
+- **Use AI to explore & document** — connect AI tools directly to your catalog
+
+## Use AI with Your Catalog
+
+### Skills
+
+Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
+
+```sh
+npx skills add event-catalog/skills
+```
+
+Skills can generate service documentation, create domain models, and map business flows — all through natural language.
+
+### MCP Server
+
+Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
+
+## Learn More
+
+- [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
+- [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
+- [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
+- [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
+- [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
+- [Discord](https://discord.gg/3rjaZMmrAm) — join the community
+
+## Found a problem?
+
+Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
diff --git a/packages/create-eventcatalog/templates/openapi/README-template.md b/packages/create-eventcatalog/templates/openapi/README-template.md
@@ -1 +1,59 @@
 # My Event Catalog
+
+Welcome to your new catalog, powered by [EventCatalog](https://www.eventcatalog.dev) — the open-source documentation tool for event-driven architectures.
+
+## Getting Started
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see your catalog.
+
+You can start editing your catalog by adding **domains**, **services**, and **messages** to this project. Each resource is a folder with an `index.md` file containing frontmatter metadata and markdown content.
+
+## What Can You Do?
+
+- **Document services** — define producers and consumers with their schemas
+- **Map events, commands & queries** — capture every message flowing through your system
+- **Organize with domains** — group resources into bounded contexts
+- **Visualize your architecture** — auto-generated diagrams of your services and message flows
+- **Version everything** — track how your architecture evolves over time
+- **Use AI to explore & document** — connect AI tools directly to your catalog
+
+## Use AI with Your Catalog
+
+### Skills
+
+Let AI agents document your architecture for you. Install [EventCatalog Skills](https://github.com/event-catalog/skills):
+
+```sh
+npx skills add event-catalog/skills
+```
+
+Skills can generate service documentation, create domain models, and map business flows — all through natural language.
+
+### MCP Server
+
+Connect your catalog to Claude, Cursor, Windsurf, or any MCP-compatible AI tool using the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server). Ask questions about your architecture and get instant answers.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Confluent Schema Registry, AWS EventBridge, and more — so your documentation is always up to date.
+
+## Automate Your Catalog
+
+Keep your catalog in sync with your architecture using [EventCatalog integrations](https://www.eventcatalog.dev/integrations). Import services, messages, and schemas from sources like AsyncAPI, OpenAPI, Schema Registries, and more — so your documentation is always up to date.
+
+## Learn More
+
+- [Documentation](https://www.eventcatalog.dev/docs/development/getting-started/introduction) — understand how EventCatalog works
+- [Adding Services](https://www.eventcatalog.dev/docs/development/guides/services) — document your first service
+- [Adding Messages](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages) — create events, commands, and queries
+- [Adding Domains](https://www.eventcatalog.dev/docs/development/guides/domains) — organize into bounded contexts
+- [SDK](https://www.eventcatalog.dev/docs/development/sdk) — manage your catalog programmatically
+- [Discord](https://discord.gg/3rjaZMmrAm) — join the community
+
+## Found a problem?
+
+Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@eventcatalog/create-eventcatalog": patch
 +---
++
 +Improve generated README with getting started guide, AI tools, integrations, and learning resources