readme
Update README
Update the project README.md with comprehensive documentation.
-
Analyze Project Structure and State
- List the files in the root directory to identify the project type (Node.js, Python, etc.).
- Read key configuration files if they exist (e.g.,
package.json,tsconfig.json,shopify.app.toml,fly.toml,requirements.txt,Gemfile,cargo.toml). - List the contents of valid source directories (e.g.,
app/,src/,lib/,components/) to understand the architecture.
-
Read Existing Documentation
- Read the current
README.mdto preserve any manual sections or specific instructions the user has added. - If available, read
.agent/brain/task.mdorimplementation_plan.mdto understand recent changes and current features (optional, do not fail if missing).
- Read the current
-
Generate/Update README.md
- Rewrite
README.mdto include the following sections (adapt as necessary for the project type):- Project Title & Description: A clear summary of what the project does.
- Features: A list of key features inferred from the codebase and installed packages/skills.
- Tech Stack: Languages, frameworks, and key libraries used.
- Prerequisites: Tools needed to run the project (Node, Python, Docker, etc.).
- Rewrite
More from toilahuongg/shopify-agents-kit
shopify-polaris-icons
Guide for using Shopify Polaris Icons in Shopify Apps. Covers icon usage patterns, accessibility, tone variants, and common icon categories for commerce applications.
19email-template-design
Design and build professional HTML email templates with inline CSS for broad email client compatibility. Use this skill when the user asks to create, design, or build email templates, newsletters, transactional emails (order confirmations, receipts, shipping notifications, password resets), marketing emails, welcome series, onboarding emails, abandoned cart emails, drip campaigns, or any HTML email layout. Covers responsive design, dark mode support, and compatibility with Gmail, Outlook (desktop + web), Apple Mail, Yahoo, and mobile clients.
18shopify-extensions
Guide for building and managing Shopify Extensions (Admin, Checkout, Theme, Post-purchase, etc.) using the latest Shopify CLI and APIs.
14shopify-api
Comprehensive guide for Shopify APIs in Remix apps. Covers Admin GraphQL/REST, Storefront API, all resources (products, orders, customers, inventory, collections, discounts, fulfillments, metafields, files), bulk operations, webhooks, resource pickers, and TypeScript patterns. Use when querying/mutating Shopify data or building integrations.
14shopify-polaris-viz
Guide for creating data visualizations in Shopify Apps using the Polaris Viz library. Use this skill when building charts, graphs, dashboards, or any data visualization components that need to integrate with the Shopify Admin aesthetic. Covers BarChart, LineChart, DonutChart, SparkLineChart, and theming.
13code-investigator
Comprehensive code investigation and audit tool. Discovers all project features, then dispatches parallel subagents to analyze issues, risks, dead code, missing functionality, and redundancies. Produces a prioritized risk report. Use this skill when the user asks to "investigate code", "audit project", "find risks", "check code quality", "analyze codebase", "what's wrong with this code", "project health check", "code review entire project", "find dead code", "find redundant code", or any request for a thorough codebase analysis.
11