Skip to content

Commit 112880d

Browse files
committed
docs
1 parent 1df32e8 commit 112880d

File tree

1 file changed

+31
-21
lines changed

1 file changed

+31
-21
lines changed

README.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,25 @@ Say goodbye to unnoticed, years-old dependencies!
2020

2121
<br>
2222

23-
## Install
24-
25-
```bash
26-
composer require rector/jack --dev
27-
```
28-
29-
<br>
30-
3123
## Why Jack?
3224

33-
Manually upgrading dependencies can be daunting, especially when tackling multiple outdated packages at once. Large upgrades often lead to errors, compatibility issues, and costly delays. Jack automates and simplifies this process by:
25+
Manually upgrading dependencies can be daunting, especially when tackling multiple outdated packages at once. Large upgrades often lead to errors, compatibility issues, and costly delays.
26+
27+
Jack automates and simplifies this process by:
3428

3529
- Monitoring outdated dependencies via CI.
3630
- Gradually opening up package versions for safe updates.
3731
- Prioritizing low-risk updates (e.g., dev dependencies).
3832

39-
With Jack, you upgrade **slowly and steadily**, avoiding the stress of massive, error-prone dependency overhauls.
33+
<br>
34+
35+
## Install
36+
37+
Rector Jack is downgraded and scoped. It requires **PHP 7.2+** and can be installed on any legacy project.
38+
39+
```bash
40+
composer require rector/jack --dev
41+
```
4042

4143
<br>
4244

@@ -48,29 +50,33 @@ Jack offers two powerful commands to keep your dependencies up to date:
4850

4951
### 1. Too many outdated dependencies? Let your CI tell you
5052

51-
Postponing upgrades often results in large, risky jumps (e.g., updating every few years). Jack integrates with your CI pipeline to catch outdated dependencies early.
53+
Postponing upgrades often results in large, risky jumps (e.g., updating once a 3 years). Jack integrates with your CI pipeline to catch outdated dependencies early.
5254

53-
Run the `breakpoint` command to check for outdated major packages:
55+
Run the `breakpoint` command to check for **outdated major packages**:
5456

5557
```bash
5658
vendor/bin/jack breakpoint
5759
```
5860

5961
<br>
6062

61-
By default, CI fails if there are more than **5 outdated packages**. Customize this limit to suit your project’s needs:
63+
If there are more than 5 major outdated packages, the **CI will fail**.
64+
65+
<br>
66+
67+
Use `--limit` to raise or lower your bar:
6268

6369
```bash
6470
vendor/bin/jack breakpoint --limit 3
6571
```
6672

67-
This ensures upgrades stay on your radar without overwhelming you. No more "oops, our dependencies are three years old" moments!
73+
This ensures upgrades stay on your radar without overwhelming you. No more "oops, our 30 dependencies are 5 years old" moments!
6874

6975
<br>
7076

7177
### 2. Open up Next Versions
7278

73-
We know we're behind the latest versions of our dependencies, but where to start? Which versions should be force to update first? We can get lot of errors if we try to bump wrong end of knot.
79+
We know we're behind the latest versions of our dependencies, but where to start? Which versions should be force to update first? We can get lot of conflicts if we try to bump wrong end of knot.
7480

7581
Instead, let composer handle it. How? We open-up package versions to the next version:
7682

@@ -89,29 +95,33 @@ Instead, let composer handle it. How? We open-up package versions to the next ve
8995
}
9096
```
9197

92-
This "opens up" versions without forcing updates. If no blockers exist, Composer will upgrade to the next version.
98+
This "opens up" 5 versions without forcing updates. If no blockers exist, Composer will upgrade to the next version.
9399

94-
<br>
100+
Then we run composer and let it do the work:
101+
102+
```bash
103+
composer update
104+
```
95105

96-
Command Options:
106+
<br>
97107

98-
**Limit the number of packages** to process (default: 5):
108+
To change the number of packages, use `--limit` option:
99109

100110
```bash
101111
vendor/bin/jack open-versions --limit 3
102112
```
103113

104114
<br>
105115

106-
**Dry run** to preview changes without modifying `composer.json`:
116+
To preview changes without modifying `composer.json`, use:
107117

108118
```bash
109119
vendor/bin/jack open-versions --dry-run
110120
```
111121

112122
<br>
113123

114-
**Update dev dependencies first** for safer, low-risk updates:
124+
Do you want to play it safe? Try low-risk dev packages first:
115125

116126
```bash
117127
vendor/bin/jack open-versions --dev

0 commit comments

Comments
 (0)