diff --git a/.cursor/rules/cloudinary.mdc b/.cursor/rules/cloudinary.mdc new file mode 100644 index 00000000..c0d61fe7 --- /dev/null +++ b/.cursor/rules/cloudinary.mdc @@ -0,0 +1,8 @@ +--- +description: Cloudinary frontend-frameworks — agent guide +alwaysApply: true +--- + +Read and follow `AGENTS.md` in the repository root. It is the single +authoritative guide for this package: build/test commands, conventions, +gotchas, and when to use this SDK versus a sibling Cloudinary package. diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..dd451281 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,5 @@ +# Cloudinary frontend-frameworks — instructions for AI coding agents + +Read `AGENTS.md` in the repository root and follow it. It is the single +authoritative guide for this package: build/test commands, conventions, +gotchas, and when to use this SDK versus a sibling Cloudinary package. diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..04eb5b45 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,87 @@ +# AGENTS.md — frontend-frameworks + +## What this monorepo is (one line) +The current Cloudinary React/Angular/Vue **component** SDKs — `` / `` plus plugins — built on `@cloudinary/url-gen`. A Lerna 4 monorepo (independent versioning) publishing `@cloudinary/react`, `@cloudinary/ng` (Angular), `@cloudinary/vue`, and the shared `@cloudinary/html` layer. + +## When to use this / when NOT to use this +- **Use this when:** you're rendering media as a **React, Angular, or Vue component** and want `` / `` with plugins (`lazyload`, `responsive`, `accessibility`, `placeholder`) instead of hand-writing `` / `