diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json new file mode 100644 index 0000000..e706561 --- /dev/null +++ b/.claude-plugin/marketplace.json @@ -0,0 +1,20 @@ +{ + "$schema": "https://anthropic.com/claude-code/marketplace.schema.json", + "name": "gsap-skills", + "description": "AI skills for GSAP — core animations, timelines, ScrollTrigger, plugins, utilities, React integration, and performance best practices", + "owner": { + "name": "GreenSock", + "email": "info@greensock.com" + }, + "plugins": [ + { + "name": "gsap-skills", + "description": "Teach AI agents correct GSAP usage including tweens, timelines, ScrollTrigger, plugins, utilities, React hooks, and performance optimization", + "author": { + "name": "GreenSock" + }, + "source": ".", + "category": "productivity" + } + ] +} diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..ddb65eb --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,6 @@ +{ + "name": "gsap-skills", + "description": "AI skills for correct GSAP usage — animations, timelines, ScrollTrigger, plugins, utilities, React, and performance", + "version": "1.0.0", + "skills": "./skills/" +} diff --git a/.cursor-plugin/marketplace.json b/.cursor-plugin/marketplace.json new file mode 100644 index 0000000..24b98ac --- /dev/null +++ b/.cursor-plugin/marketplace.json @@ -0,0 +1,13 @@ +{ + "name": "gsap-skills", + "owner": { + "name": "GreenSock" + }, + "plugins": [ + { + "name": "gsap-skills", + "source": "./", + "description": "AI skills for GSAP — core animations, timelines, ScrollTrigger, plugins, utilities, React integration, and performance best practices." + } + ] +} diff --git a/.cursor-plugin/plugin.json b/.cursor-plugin/plugin.json new file mode 100644 index 0000000..22d33f3 --- /dev/null +++ b/.cursor-plugin/plugin.json @@ -0,0 +1,24 @@ +{ + "name": "gsap-skills", + "version": "1.0.0", + "description": "AI skills for GSAP — core animations, timelines, ScrollTrigger, plugins, utilities, React integration, and performance best practices", + "author": { + "name": "GreenSock", + "email": "info@greensock.com", + "url": "https://gsap.com" + }, + "license": "MIT", + "keywords": [ + "gsap", + "greensock", + "animation", + "scrolltrigger", + "timeline", + "react", + "performance", + "tweens", + "plugins" + ], + "logo": "assets/gsap-white.svg", + "skills": ["skills"] +} diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/README.md b/README.md index 19c0060..cc00695 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,41 @@ Official AI skills for GSAP. These skills teach AI coding agents how to correctl Skills follow the [Agent Skills](https://agentskills.io) format and work with the [skills](https://github.com/vercel-labs/skills) CLI (Cursor, Claude Code, Codex, Windsurf, GitHub Copilot, and others). -## Installation +## Installing -Install all GSAP skills with the skills CLI: +These skills work with any agent that supports the Agent Skills standard, including Claude Code, Cursor, and others. -```bash -npx skills add /gsap-skills +### Claude Code + +Install using the [plugin marketplace](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/plugins#add-from-marketplace): + +``` +/plugin marketplace add greensock/gsap-skills ``` -Replace `` with the GitHub org or username (e.g. `greensock/gsap-skills`). To list skills without installing: +### Cursor -```bash -npx skills add /gsap-skills --list +Install from the Cursor Marketplace or add manually via **Settings > Rules > Add Rule > Remote Rule (Github)** with `greensock/gsap-skills`. + +### npx skills + +Install using the [`npx skills`](https://skills.sh) CLI: + +``` +npx skills add https://github.com/greensock/gsap-skills ``` -To install a single skill by name: +### Clone / Copy -```bash -npx skills add /gsap-skills --skill gsap-core -``` +Clone this repo and copy the skill folders into the appropriate directory for your agent: -Agents use each skill when the task matches the skill’s `description` (e.g. “scroll animation” → gsap-scrolltrigger). +| Agent | Skill Directory | Docs | +|-------|-----------------|------| +| Claude Code | `~/.claude/skills/` | [docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/skills) | +| Cursor | `~/.cursor/skills/` | [docs](https://docs.cursor.com/context/rules) | +| OpenCode | `~/.config/opencode/skills/` | [docs](https://opencode.ai/docs/skills/) | +| OpenAI Codex | `~/.codex/skills/` | [docs](https://developers.openai.com/codex/skills/) | +| Pi | `~/.pi/agent/skills/` | [docs](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent#skills) | ## Skills @@ -57,4 +71,8 @@ gsap-skills/ ## Compatibility - **[skills CLI](https://github.com/vercel-labs/skills)** — installs into Cursor, Claude Code, Codex, Windsurf, GitHub Copilot, and [40+ agents](https://github.com/vercel-labs/skills#supported-agents) -- **[Agent Skills spec](https://agentskills.io/specification.md)** — SKILL.md format and discovery \ No newline at end of file +- **[Agent Skills spec](https://agentskills.io/specification.md)** — SKILL.md format and discovery + +## License + +MIT \ No newline at end of file diff --git a/assets/gsap-white.svg b/assets/gsap-white.svg new file mode 100644 index 0000000..3a755dd --- /dev/null +++ b/assets/gsap-white.svg @@ -0,0 +1,7 @@ + + + + + + +