0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/scripts/README-template.md
Lennart e983f74987
chore(*): Update/unify/add READMEs (#22858)
Co-authored-by: Mastra Code (openai/gpt-5.6-sol) <noreply@mastra.ai>
2026-09-02 14:36:59 +02:00

1.3 KiB

package-name

2-3 sentence description of what the package does. Mention some of its features. Write for a stranger. Assume the reader has never heard of it and has thirty seconds to understand its purpose. Do not explain internal implementation details or use complex jargon, just break down the core functionality and value proposition. Like elevator pitch style for why you should use this (but not in a markety speech).

Installation

npm install package-name

Usage

Show, don't tell. A basic example of how to use the package. If the snippet produces an output, put it into the code block as a comment. Otherwise, just show the easiest way to get started. We can link to any additional documentation if needed. If there are any prerequisites for using this, write them above the code block, such as required environment variables, dependencies, or setup steps.

Documentation

Link to relevant documentation pages (as a list)

Changelog

Link to the exact changelog files on GitHub for that package (e.g. https://github.com/mastra-ai/mastra/blob/main/packages/cli/CHANGELOG.md). The link should point directly to the relevant file for easy access.

Support

We have an open community Discord. Come and say hello and let us know if you have any questions or need any help getting things running.