Skip to content

Commit b4e484a

Browse files
authored
docs: align README and roadmap with shipped functionality (#14)
Keep the public docs in sync with the current tag: features, CLI commands, and roadmap status that were behind the code.
1 parent 1df05b1 commit b4e484a

2 files changed

Lines changed: 6 additions & 26 deletions

File tree

README.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ Supported PHP versions follow `composer.json` (`>=8.1 <8.6`). Release history is
5050
composer require --dev nowo-tech/composer-update-helper
5151
```
5252

53-
> 💡 **Tip**: We also recommend installing [Code Review Guardian](https://github.com/nowo-tech/CodeReviewGuardian) for a complete code quality workflow. See [Related Packages](#related-packages) section below.
54-
5553
After installation, two files will be copied to your project root:
5654
- `generate-composer-require.sh` - The lightweight wrapper script (delegates complex logic to PHP in vendor)
5755
- `generate-composer-require.yaml` - Configuration file for ignored and included packages (only created if doesn't exist)
@@ -283,36 +281,16 @@ When the Packagist API doesn't have information about these packages, the tool a
283281
> 💡 **Tip**: If you're using a VPN or behind a corporate firewall, configuring a Packagist mirror or ensuring `composer show` works will provide the best experience.
284282

285283
## Related Packages
286-
### Code Review Guardian
287284

288-
Looking for a complete code review solution? We highly recommend **[Code Review Guardian](https://github.com/nowo-tech/CodeReviewGuardian)** - a provider-agnostic code review guardian that works perfectly with Composer Update Helper:
285+
### PHP Quality Tools
289286

290-
- ✅ **Provider-agnostic**: Works with GitHub, GitLab, Bitbucket, and any Git provider
291-
- ✅ **Multi-framework support**: Automatic framework detection (Symfony, Laravel, etc.)
292-
- ✅ **Code quality checks**: PHP-CS-Fixer, PHPStan, PHPUnit, Security checks
293-
- ✅ **Easy integration**: Simple YAML configuration
294-
- ✅ **Framework-specific configs**: Optimized configurations for each framework
287+
For Rector / PHP-CS-Fixer / Twig-CS-Fixer configs with automatic framework detection, use **[PHP Quality Tools](https://github.com/nowo-tech/PhpQualityTools)** (`nowo-tech/php-quality-tools`). [Code Review Guardian](https://github.com/nowo-tech/CodeReviewGuardian) is **abandoned** and should not be installed on new projects.
295288

296-
**Installation:**
297289
```bash
298-
composer require --dev nowo-tech/code-review-guardian
290+
composer require --dev nowo-tech/php-quality-tools
299291
```
300292

301-
**Why use both together?**
302-
303-
Together with Composer Update Helper, you get a complete development workflow:
304-
305-
1. **Composer Update Helper** → Keeps your dependencies up to date
306-
- Automatically detects outdated packages
307-
- Generates update commands
308-
- Respects framework version constraints
309-
310-
2. **Code Review Guardian** → Ensures code quality in your pull requests
311-
- Runs code quality checks automatically
312-
- Validates code style and standards
313-
- Prevents merging low-quality code
314-
315-
**Perfect combination for maintaining high-quality PHP projects!** 🚀
293+
Composer Update Helper keeps dependencies current; PHP Quality Tools keeps style and static-analysis configs in sync with the framework.
316294

317295
## Documentation
318296

docs/IMPLEMENTATION_ROADMAP.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This document provides a detailed action plan for implementing the not-yet-supported update scenarios, ordered by complexity and feasibility.
44

5+
**Status (v2.0.34, 2026-08):** Phase 1 and most of Phase 2 are **shipped** (fallback versions, alternative packages, abandoned detection, conflict impact, wildcard checking, maintainer contact). Still open: batch update optimization, cascading conflict chains, circular dependency conflicts, repository-specific conflicts, pre-installation conflict prediction. The “Weeks 1–19” timeline below is historical, not a schedule.
6+
57
## Table of contents
68

79
- [Implementation Priority Matrix](#implementation-priority-matrix)

0 commit comments

Comments
 (0)