Prompt file imported from ejunior95/discordia (
.github/prompts/update-readme.prompt.md). Copyright stays with the author.
Update README.md so it accurately reflects the current state of this workspace.
Use any text provided with the prompt invocation as the focus area.
Process:
- Inspect the existing README first and preserve its useful structure and project voice when possible.
- Write README content in Brazilian Portuguese.
- Inspect the relevant source/config files before editing. Prioritize package.json, docker-compose.yml, .exemplo.env, src/app.module.ts, src/main.ts, and changed files from the current git diff when available.
- Update only README sections that are stale, missing, misleading, or directly related to the requested focus.
- Keep setup and command examples aligned with this repository's package manager and scripts. Use
pnpmcommands unless the repository clearly changes package managers. - Document required environment variables at a practical level without exposing secrets or inventing values.
- Mention important runtime expectations, such as MongoDB, cookies/auth, CORS, Docker, tests, and development commands, only when they are supported by the codebase.
- Keep the README concise and useful for a developer cloning the project. Avoid marketing filler, unverified claims, and broad rewrites unrelated to the requested focus.
- After editing, validate Markdown structure and report what changed plus anything that could not be verified.
Output style:
- Make the edit directly.
- Summarize changed sections in 2-5 bullets.
- List verification performed, or explain why verification was not run.
- Call out any remaining README gaps as follow-up items.