Skip to content

Commit c2ecd41

Browse files
committed
Update README.md
1 parent 796320a commit c2ecd41

1 file changed

Lines changed: 15 additions & 41 deletions

File tree

README.md

Lines changed: 15 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A simple PHP CLI tool for working with [SemVer](https://semver.org/) version str
1010

1111
## Requirements
1212

13-
* PHP 7.0 or higher
13+
* PHP 7.4 or higher
1414
* Composer
1515

1616
## 📦 Installation
@@ -19,51 +19,25 @@ You can install it globally or locally using Composer:
1919

2020
```bash
2121
composer global require syntatis/version-cli-php
22+
```
2223

23-
Or to use as a development dependency in your project:
24+
Or, use as a development dependency in your project:
2425

26+
```bash
2527
composer require --dev syntatis/version-cli-php
28+
```
2629

27-
🚀 Usage
28-
29-
Run the CLI using:
30-
31-
version
32-
33-
If installed locally:
34-
35-
vendor/bin/version
36-
37-
🔼 Increment a version
38-
39-
version bump 1.2.3 patch
40-
# Output: 1.2.4
41-
42-
version bump 1.2.3 minor
43-
# Output: 1.3.0
44-
45-
version bump 1.2.3 major
46-
# Output: 2.0.0
30+
## Usage
4731

48-
⚖️ Compare versions
32+
If you run it globally, you can use the `version` command directly in your terminal:
4933

50-
version compare 1.2.3 1.2.4
51-
# Output: -1 (meaning 1.2.3 < 1.2.4)
52-
53-
version compare 2.0.0 1.9.9
54-
# Output: 1 (meaning 2.0.0 > 1.9.9)
55-
56-
version compare 1.2.3 1.2.3
57-
# Output: 0 (meaning both are equal)
58-
59-
🧪 Testing
60-
61-
Run tests using PHPUnit:
62-
63-
composer test
64-
65-
📄 License
34+
```bash
35+
version --help
36+
```
6637

67-
MIT © Syntatis
38+
If you installed it locally in your project, run it using the vendor binary:
6839

69-
Let me know if this tool supports pre-releases (`1.0.0-beta.1`) or build metadata (`+001`), so I can include that in the README too.
40+
```bash
41+
vendor/bin/version --help
42+
```
43+
## Commands

0 commit comments

Comments
 (0)