Skip to content

Commit 0e8f883

Browse files
committed
docs: update README structure and documentation links
1 parent 26f6fff commit 0e8f883

1 file changed

Lines changed: 93 additions & 95 deletions

File tree

README.md

Lines changed: 93 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ This bundle is **FrankenPHP worker mode friendly**.
4040
-**Lightweight architecture**: Script delegates complex logic to PHP in vendor, keeping the repo script lightweight and maintainable
4141
- ⚠️ **Internationalization (i18n)** (DEVELOPMENT MODE): Multi-language support for output messages with automatic language detection
4242

43+
## Version information
44+
45+
Supported PHP versions follow `composer.json` (`>=8.1 <8.6`). Release history is in [docs/CHANGELOG.md](docs/CHANGELOG.md).
46+
4347
## Installation
4448

4549
```bash
@@ -93,64 +97,10 @@ The script automatically detects `process-updates.php` in `vendor/nowo-tech/comp
9397
-**Better maintainability**: Clear separation of concerns
9498
-**Automatic detection**: No configuration needed
9599

96-
## Usage
97-
98-
### Basic Usage
99-
100-
```bash
101-
# Show suggested update commands
102-
./generate-composer-require.sh
103-
104-
# Execute commands directly
105-
./generate-composer-require.sh --run
106-
107-
# Show release information
108-
./generate-composer-require.sh --release-info
109-
110-
# Show full changelogs
111-
./generate-composer-require.sh --release-detail
112-
113-
# Show impact analysis for conflicting packages
114-
./generate-composer-require.sh --show-impact
115-
116-
# Save impact analysis to file
117-
./generate-composer-require.sh --save-impact
118-
119-
# Verbose output
120-
./generate-composer-require.sh --verbose
121-
122-
# Debug mode
123-
./generate-composer-require.sh --debug
124-
125-
# Show help
126-
./generate-composer-require.sh --help
127-
```
128-
129-
Example output:
130-
131-
```
132-
⏭️ Ignored packages (prod):
133-
- doctrine/doctrine-bundle:2.13.2
134-
135-
🔧 Suggested commands:
136-
composer require --with-all-dependencies vendor/package:1.2.3 another/package:4.5.6
137-
composer require --dev --with-all-dependencies phpstan/phpstan:2.0.0
138-
```
139-
140-
> **Note:** By default, release information is **not shown** (no API calls are made). Use `--release-info` or `--release-detail` to enable it.
141-
142-
**Available options:**
143-
- `--run` - Execute suggested commands automatically
144-
- `--release-info` - Show release information (summary with links)
145-
- `--release-detail` - Show full release changelog for each package (implies `--release-info`)
146-
- `--no-release-info` - Skip release information section (default behavior)
147-
- `--show-impact, --impact` - Show impact analysis for conflicting packages (disabled by default)
148-
- `--save-impact` - Save impact analysis to `composer-update-impact.txt` file (implies `--show-impact`)
149-
- `-v, --verbose` - Show verbose output (configuration files, packages, etc.)
150-
- `--debug` - Show debug information (very detailed, includes file paths, parsing, etc.)
151-
- `-h, --help` - Show help message
100+
## Requirements
152101

153-
For detailed usage information, see [Usage Guide](docs/USAGE.md).
102+
- PHP `>=8.1 <8.6`
103+
- Composer 2.x
154104

155105
## Configuration
156106

@@ -210,6 +160,64 @@ For detailed configuration options including language settings, dependency check
210160

211161
For framework support details, see [Framework Support](docs/FRAMEWORKS.md).
212162

163+
## Usage
164+
### Basic Usage
165+
166+
```bash
167+
# Show suggested update commands
168+
./generate-composer-require.sh
169+
170+
# Execute commands directly
171+
./generate-composer-require.sh --run
172+
173+
# Show release information
174+
./generate-composer-require.sh --release-info
175+
176+
# Show full changelogs
177+
./generate-composer-require.sh --release-detail
178+
179+
# Show impact analysis for conflicting packages
180+
./generate-composer-require.sh --show-impact
181+
182+
# Save impact analysis to file
183+
./generate-composer-require.sh --save-impact
184+
185+
# Verbose output
186+
./generate-composer-require.sh --verbose
187+
188+
# Debug mode
189+
./generate-composer-require.sh --debug
190+
191+
# Show help
192+
./generate-composer-require.sh --help
193+
```
194+
195+
Example output:
196+
197+
```
198+
⏭️ Ignored packages (prod):
199+
- doctrine/doctrine-bundle:2.13.2
200+
201+
🔧 Suggested commands:
202+
composer require --with-all-dependencies vendor/package:1.2.3 another/package:4.5.6
203+
composer require --dev --with-all-dependencies phpstan/phpstan:2.0.0
204+
```
205+
206+
> **Note:** By default, release information is **not shown** (no API calls are made). Use `--release-info` or `--release-detail` to enable it.
207+
208+
**Available options:**
209+
- `--run` - Execute suggested commands automatically
210+
- `--release-info` - Show release information (summary with links)
211+
- `--release-detail` - Show full release changelog for each package (implies `--release-info`)
212+
- `--no-release-info` - Skip release information section (default behavior)
213+
- `--show-impact, --impact` - Show impact analysis for conflicting packages (disabled by default)
214+
- `--save-impact` - Save impact analysis to `composer-update-impact.txt` file (implies `--show-impact`)
215+
- `-v, --verbose` - Show verbose output (configuration files, packages, etc.)
216+
- `--debug` - Show debug information (very detailed, includes file paths, parsing, etc.)
217+
- `-h, --help` - Show help message
218+
219+
For detailed usage information, see [Usage Guide](docs/USAGE.md).
220+
213221
## Packagist Integration
214222

215223
Composer Update Helper fetches package information from Packagist to analyze dependencies and find compatible versions. Here's how it works:
@@ -274,43 +282,7 @@ When the Packagist API doesn't have information about these packages, the tool a
274282

275283
> 💡 **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.
276284

277-
## Requirements
278-
279-
- PHP `>=8.1 <8.6`
280-
- Composer 2.x
281-
282-
## Version information
283-
284-
Supported PHP versions follow `composer.json` (`>=8.1 <8.6`). Release history is in [docs/CHANGELOG.md](docs/CHANGELOG.md).
285-
286-
## Documentation
287-
288-
- [Installation](docs/INSTALLATION.md)
289-
- [Configuration](docs/CONFIGURATION.md)
290-
- [Usage](docs/USAGE.md)
291-
- [Contributing](docs/CONTRIBUTING.md)
292-
- [Code of Conduct](CODE_OF_CONDUCT.md)
293-
- [Changelog](docs/CHANGELOG.md)
294-
- [Upgrading](docs/UPGRADING.md)
295-
- [Release](docs/RELEASE.md)
296-
- [Security](docs/SECURITY.md)
297-
- [Engram](docs/ENGRAM.md)
298-
- [Spec-driven development](docs/SPEC-DRIVEN-DEVELOPMENT.md)
299-
- [GitHub Spec Kit](docs/SPEC-KIT.md)
300-
301-
### Additional documentation
302-
303-
- [GitHub Actions CI requirements](docs/GITHUB_CI.md)
304-
- [Framework support](docs/FRAMEWORKS.md)
305-
- [Update cases and scenarios](docs/UPDATE_CASES.md)
306-
- [Testing](docs/TESTING.md)
307-
- [Implementation roadmap](docs/IMPLEMENTATION_ROADMAP.md)
308-
- [Development](docs/DEVELOPMENT.md)
309-
- [Branching](docs/BRANCHING.md)
310-
- [I18N strategy](docs/I18N_STRATEGY.md)
311-
312285
## Related Packages
313-
314286
### Code Review Guardian
315287

316288
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:
@@ -342,9 +314,31 @@ Together with Composer Update Helper, you get a complete development workflow:
342314

343315
**Perfect combination for maintaining high-quality PHP projects!** 🚀
344316

345-
## Author
317+
## Documentation
346318

347-
Created by [Héctor Franco Aceituno](https://github.com/HecFranco) at [Nowo.tech](https://nowo.tech)
319+
- [Installation](docs/INSTALLATION.md)
320+
- [Configuration](docs/CONFIGURATION.md)
321+
- [Usage](docs/USAGE.md)
322+
- [Contributing](docs/CONTRIBUTING.md)
323+
- [Code of Conduct](CODE_OF_CONDUCT.md)
324+
- [Changelog](docs/CHANGELOG.md)
325+
- [Upgrading](docs/UPGRADING.md)
326+
- [Release](docs/RELEASE.md)
327+
- [Security](docs/SECURITY.md)
328+
- [Engram](docs/ENGRAM.md)
329+
- [Spec-driven development](docs/SPEC-DRIVEN-DEVELOPMENT.md)
330+
- [GitHub Spec Kit](docs/SPEC-KIT.md)
331+
332+
### Additional documentation
333+
334+
- [GitHub Actions CI requirements](docs/GITHUB_CI.md)
335+
- [Framework support](docs/FRAMEWORKS.md)
336+
- [Update cases and scenarios](docs/UPDATE_CASES.md)
337+
- [Testing](docs/TESTING.md)
338+
- [Implementation roadmap](docs/IMPLEMENTATION_ROADMAP.md)
339+
- [Development](docs/DEVELOPMENT.md)
340+
- [Branching](docs/BRANCHING.md)
341+
- [I18N strategy](docs/I18N_STRATEGY.md)
348342

349343
## Tests and coverage
350344

@@ -356,3 +350,7 @@ Created by [Héctor Franco Aceituno](https://github.com/HecFranco) at [Nowo.tech
356350
## License
357351

358352
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
353+
## Author
354+
355+
Created by [Héctor Franco Aceituno](https://github.com/HecFranco) at [Nowo.tech](https://nowo.tech)
356+

0 commit comments

Comments
 (0)