Skip to content

feat: add README Generator agent#452

Open
jbkun069 wants to merge 1 commit into
AditthyaSS:mainfrom
jbkun069:agent/readme-generator
Open

feat: add README Generator agent#452
jbkun069 wants to merge 1 commit into
AditthyaSS:mainfrom
jbkun069:agent/readme-generator

Conversation

@jbkun069

@jbkun069 jbkun069 commented Jun 4, 2026

Copy link
Copy Markdown

What does this PR do?

Adds a new readme-generator agent that creates clean, professional, and developer-friendly README.md files. It takes a repository URL, project description, tech stack, and desired sections as inputs to automatically generate copy-pasteable documentation.

Type of change

  • New agent
  • Bug fix
  • UI improvement
  • Docs update
  • Something else (describe below)

Checklist

For every PR:

  • I was assigned to this issue before starting
  • I have read CONTRIBUTING.md
  • This PR is linked to issue [Agent]: README Generator #148
  • I tested this locally with npm run dev
  • No API keys are anywhere in my code
  • I did not add any new packages without discussing it first

For new agent PRs:

  • I tested the agent with a real API key
  • I created a new file in src/agents/definitions/ with the agent config
  • The agent id is lowercase and uses kebab-case (like my-agent-name)
  • The icon name is from [lucide.dev/icons](https://lucide.dev/icons)
  • The system prompt clearly describes the format of the output
  • This agent is not a duplicate of one that already exists

Anything else I should know?

The agent is configured to use claude-sonnet-4-6 via Anthropic as its default provider, though it supports any provider. The system prompt is heavily optimized to output valid GitHub-flavored Markdown without conversational filler so it can be directly copied into a repository.

closes #148

@jbkun069 jbkun069 requested a review from AditthyaSS as a code owner June 4, 2026 07:17
@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

@jbkun069 is attempting to deploy a commit to the aditthyass' projects Team on Vercel.

A member of the Team first needs to authorize it.

@mergify

mergify Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Hey @jbkun069! 👋
Wow — your first contribution to iloveAgents! This is a big deal and I want you to know it means a lot. 🎊
Every agent on this platform started exactly like this — someone like you deciding to spend their time building something useful for everyone. That is something to be proud of.
A few things while you wait for the review:

  • Star the repo if you haven't already. Star it here
  • 📖 Check the Contributing Guide
  • 💬 Drop a comment if you get stuck — I reply within 24 hours
    Can't wait to ship this with you. 🚀
    Welcome to the iloveAgents family. 🙏
    @AditthyaSS

@mergify

mergify Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

hey @jbkun069! 👋
Your PR doesn't seem to be linked to an issue.
Please add this line to your PR description:
Closes #issue_number
Replace issue_number with the actual issue number you are solving.
This helps us track what each PR is fixing! 🔗
@AditthyaSS

@jbkun069

jbkun069 commented Jun 4, 2026

Copy link
Copy Markdown
Author

@AditthyaSS review it and kindly add gssoc:approved if satisfied

@mergify mergify Bot added the needs-fix label Jun 4, 2026
@jbkun069

jbkun069 commented Jun 4, 2026

Copy link
Copy Markdown
Author

hey @jbkun069! 👋 Your PR doesn't seem to be linked to an issue. Please add this line to your PR description: Closes #issue_number Replace issue_number with the actual issue number you are solving. This helps us track what each PR is fixing! 🔗 — @AditthyaSS

done

@mergify mergify Bot added the new agents label Jun 6, 2026
@mergify mergify Bot added the new agent label Jun 6, 2026
@mergify mergify Bot added the new agent label Jun 6, 2026
@jbkun069

jbkun069 commented Jun 7, 2026

Copy link
Copy Markdown
Author

@AditthyaSS any problems?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Agent]: README Generator

2 participants