readme
SKILL.md
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.).
- Getting Started / Installation: Step-by-step instructions to install dependencies and run the project (e.g.,
npm install,npm run dev). - Project Structure: A high-level overview of the main directories.
- Workflows & Skills: Mention available workflows (like this one) or skills if relevant.
- License: If a license file exists, mention it.
- Rewrite
-
Review and Verification
- Ensure the new
README.mdis formatted correctly in Markdown. - Check that all links (if any) are valid.
- Ensure the new
Weekly Installs
4
Repository
toilahuongg/sho…ents-kitGitHub Stars
6
First Seen
10 days ago
Security Audits
Installed on
claude-code4
opencode3
gemini-cli3
github-copilot3
codex3
kimi-cli3