Inspiration We were tired of writing and updating README files manually every time we made changes to our projects. As developers, we wanted to focus on coding, not on keeping documentation up to date. So we thought - why not automate this boring but important task? What it does GenREADME automatically creates and updates your README.md files whenever you push code to GitLab. It listens for changes in your repository through webhooks and generates fresh documentation without you having to think about it. Push your code, and your README stays current. How we built it We built it using Java and Maven because we wanted something reliable and easy to deploy. The app sets up a webhook endpoint that GitLab can talk to, listens for push events and other repository changes, then automatically updates the README file based on what's happening in your project. Challenges we ran into Creating effective prompts for the AI was surprisingly difficult - we had to figure out how to get it to understand our codebase context without overwhelming it with information.
Accomplishments that we're proud of
We built something that genuinely improves the developer experience. Our context-aware AI doesn't just generate generic templates - it creates documentation that actually reflects what your project does and how to use it. The ecosystem intelligence we achieved through MCP integration means the AI has a holistic view of your project, not just surface-level file scanning.
What's next for GenREADME
Log in or sign up for Devpost to join the conversation.