From 70e150611b4ea72d73b2f5330c7dc022247fca46 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Sat, 13 Dec 2025 22:26:20 +0545 Subject: [PATCH] refactor(docs): Overhaul README for improved clarity and quick start The `README.md` has undergone a significant rewrite and restructuring to enhance readability, streamline the onboarding process, and better communicate the value proposition of DevGen. This includes a new introduction, a consolidated "Why DevGen?" section, simplified quick start guides, and a dedicated feature deep dive. * **Enhancements & Refinements** * **Improved Introduction**: Added a concise tagline and refined the introductory paragraph, positioning DevGen as an AI co-pilot for Git and project management. * **Streamlined Feature Presentation**: Replaced the previous feature list with a "Why DevGen?" section, highlighting key benefits such as AI Brain (multi-provider support), battle-tested compliance (Conventional Commits, Semantic Versioning), lightning-fast performance, and zero-friction setup. * **Simplified Quick Start**: Refined the initial setup and commit generation steps for a quicker onboarding experience. * **Enhanced Feature Deep Dive**: Introduced a dedicated section to provide detailed usage examples for AI-powered commits, changelogs, release notes, gitignore, and license generation. * **Improved Installation Instructions**: Emphasized `pipx` and `uv` as recommended installation methods for isolated and fast CLI management. * **Concise Configuration Table**: Replaced verbose configuration details with a clear markdown table for easier reference. * **Updated PyPI Link**: Corrected the PyPI link to `devgen-cli`. * **Minor Visual Updates**: Refined badge presentation and added a centered footer with author attribution. * **Refactoring** * **Major Content Restructuring**: Completely reordered and rewrote large sections, removing redundant information and consolidating related content to improve overall flow and conciseness. * **Removed Command Reference**: Integrated command examples directly into relevant usage sections, eliminating a separate, lengthy command reference. * **Removed Redundant Sections**: Consolidated information previously found in "Use Cases" and "Requirements" into other sections, streamlining the document. --- README.md | 49 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 827f05f..8585275 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@
-> **Your AI Co-Pilot for Git & Project Management.** +> **Your AI Powerhouse for Git & Project Management.** > Stop wasting time on repetitive tasks. Automate your commits, changelogs, and project essentials with a single CLI. > > PyPI didn't allow the original name, so you'll find it as **devgen-cli** on PyPI @@ -15,15 +15,24 @@ --- -**DevGen** isn't just another CLI toolβ€”it's your development workflow on steroids. By leveraging state-of-the-art AI models, DevGen turns tedious manual tasks into one-click magic. From semantic commit messages to comprehensive release notes, DevGen handles the boring stuff so you can focus on building. +**DevGen** isn't just another CLI tool it's your development workflow on steroids. By leveraging state of the art AI models, DevGen turns tedious manual tasks into one click magic. From semantic commit messages to comprehensive release notes, DevGen handles the boring stuff so you can focus on building. ## ⚑ Why DevGen? -- **🧠 AI Brain**: Semantic commit messages powered by Gemini, OpenAI, Claude, HuggingFace, and OpenRouter. It reads your diffs and understands your code. -- **πŸš€ Battle Tested**: Generates **Conventional Commits** and **Semantic Versioning** compliant changelogs that actually make sense. -- **⚑ Lightning Fast**: Smart caching and async operations mean you never wait longer than necessary. -- **Project Essentials**: Quickly add `.gitignore` and license files to your existing projects. Access cached templates instantly, even without internet. -- **πŸ› οΈ Zero Friction**: Interactive setup gets you running in seconds. +**🧠 AI Brain** +Semantic commit messages powered by Gemini, OpenAI, Claude, HuggingFace, and OpenRouter. It reads your diffs and understands your code. + +**πŸš€ Battle Tested** +Generates **Conventional Commits** and **Semantic Versioning** compliant changelogs that actually make sense. + +**⚑ Lightning Fast** +Smart caching and async operations mean you never wait longer than necessary. + +**Project Essentials** +Quickly add `.gitignore` and license files to your existing projects. Access cached templates instantly, even without internet. + +**πŸ› οΈ Zero Friction** +Interactive setup gets you running in seconds. ## πŸ“¦ Installation @@ -57,11 +66,12 @@ git add . devgen commit run ``` -*Boom. Done.* +_Boom. Done._ ## πŸ’‘ Feature Deep Dive -### πŸ€– AI-Powered Commits +### πŸ€– AI Powered Commits + Stop writing "fix bug" or "wip". DevGen analyzes your staged changes, groups them by component, and generates meaningful, semantic commit messages. ```bash @@ -73,6 +83,7 @@ devgen commit run --push ``` ### πŸ“ Changelogs & Release Notes + Turn your git history into beautiful, readable documentation. ```bash @@ -84,6 +95,7 @@ devgen release notes --version 2.0.0 ``` ### πŸ›‘οΈ Essential Files + Don't waste time searching for templates. Generate the essential files for your project instantly. ```bash @@ -98,17 +110,26 @@ devgen license generate Your settings live in `~/.devgen.yaml`. You can tweak your AI provider, model, and preferences there. -| Option | Description | -|:---|:---| +| Option | Description | +| :--------- | :----------------------------------------------------------- | | `provider` | `gemini`, `openai`, `anthropic`, `huggingface`, `openrouter` | -| `model` | Specific model name (e.g., `gemini-2.5-flash`, `gpt-4o`) | -| `emoji` | Enable/disable gitmojis in commits (`true`/`false`) | +| `model` | Specific model name (e.g., `gemini-2.5-flash`, `gpt-4o`) | +| `emoji` | Enable/disable gitmojis in commits (`true`/`false`) | ## 🀝 Contributing We love contributions! Found a bug? Want a new feature? Open an issue or submit a PR. -## πŸ“ License +## οΏ½ Acknowledgments + +DevGen wouldn't be possible without these amazing open-source projects and AI providers: + +- **[Typer](https://typer.tiangolo.com/)** & **[Rich](https://rich.readthedocs.io/)** for building the beautiful, intuitive, and responsive CLI interface. +- **[Questionary](https://github.com/tmbo/questionary)** for creating interactive, user-friendly prompts and selection menus. +- **[Jinja2](https://jinja.palletsprojects.com/)** for the powerful template engine used to generate files and messages. +- **[Google Gemini](https://deepmind.google/technologies/gemini/)**, **[OpenAI](https://openai.com/)**, **[Anthropic](https://www.anthropic.com/)**, **[HuggingFace](https://huggingface.co/)**, and **[OpenRouter](https://openrouter.ai/)** for providing the advanced AI models that power the semantic generation features. + +## οΏ½πŸ“ License Proudly open source under the [GPL-3.0-or-later](LICENSE) License.