Add Project to README (Auto)
Instructions
When user provides a GitHub URL, automatically handle the entire process:
- •Parse the URL to extract the repository name and owner from the GitHub URL
- •Fetch repository metadata:
- •Use WebFetch to get the repository's GitHub page and extract the description/about section
- •Look for a README.md in the repo to understand the project purpose
- •Generate an appropriate emoji:
- •Analyze keywords in the description/README (e.g., "AI" → 🤖, "home" → 🏠, "search" → 🔍, "data" → 📊, "tool" → 🛠️, "web" → 🌐, "api" → 🔌, "automation" → ⚙️, "learning" → 📚, "security" → 🔐, "ml" → 🧠, "database" → 🗄️)
- •Pick the most relevant emoji based on the project type
- •Generate a one-liner description (max 80 characters):
- •Extract key information from the repo description or README
- •Create a concise, meaningful description that captures the project's purpose
- •If no description exists, infer from the repo name and content
- •Read the current README.md to locate the "### Current Projects" section
- •Add the new project in this exact format:
code
- [EMOJI] [project-name](URL) - [one-line description]
- •Update the README by appending the new project entry to the Current Projects list, maintaining proper formatting
- •Confirm by showing the user the updated Current Projects section with the new entry highlighted
- •Push the changes to GitHub:
- •Run:
git add README.md - •Run:
git commit -m "Add claude-usage-widget to Current Projects" - •Run:
git push origin master
- •Run:
Format Requirements
- •Emoji should be a single relevant character
- •Project name extracted from URL
- •Full GitHub URL must be preserved
- •Description must be single line, under 80 characters
- •Maintain consistent spacing with existing entries
Example
Input: /add-project https://github.com/user/ml-pipeline
Process:
- •Fetch repo → finds "Machine learning pipeline orchestration framework"
- •Keywords suggest 🧠 (ML) or ⚙️ (automation) → select 🧠
- •Generate 1-liner: "ML pipeline orchestration framework"
- •Update README with:
- 🧠 [ml-pipeline](https://github.com/user/ml-pipeline) - ML pipeline orchestration framework - •Show confirmed update