Skip to content

Commit 815f300

Browse files
committed
Update README.md
1 parent 9b8bc5b commit 815f300

1 file changed

Lines changed: 30 additions & 4 deletions

File tree

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# 1️⃣ version-cli-php
22

3+
[![CI](https://github.com/syntatis/version-cli-php/actions/workflows/ci.yml/badge.svg)](https://github.com/syntatis/version-cli-php/actions/workflows/ci.yml)
4+
35
A simple PHP CLI tool for working with [SemVer](https://semver.org/) version strings.
46

57
## Features
@@ -8,12 +10,14 @@ A simple PHP CLI tool for working with [SemVer](https://semver.org/) version str
810
* Compare two version strings
911
* Validates SemVer-compliant version strings
1012

11-
## Requirements
13+
## Getting Started
14+
15+
### Requirements
1216

1317
* PHP 7.4 or higher
1418
* Composer
1519

16-
## Installation
20+
### Installation
1721

1822
You can install it globally or locally using Composer:
1923

@@ -27,7 +31,7 @@ Or, use as a development dependency in your project:
2731
composer require --dev syntatis/version-cli
2832
```
2933

30-
## Usage
34+
## Commands
3135

3236
If you run it globally, you can use the `version` command directly in your terminal:
3337

@@ -40,4 +44,26 @@ If you installed it locally in your project, run it using the vendor binary:
4044
```bash
4145
vendor/bin/version --help
4246
```
43-
## Commands
47+
48+
The command provides several options to work with version strings:
49+
50+
<table>
51+
<thead>
52+
<th>Command</th>
53+
<th>Description</th>
54+
<th>Usage</th>
55+
</thead>
56+
<tbody>
57+
<tr>
58+
<td><code>validate</code></td>
59+
<td>Validates the given version string against the SemVer specification.</td>
60+
<td><code>version validate v1.0.0</code></td>
61+
</tr>
62+
</tbody>
63+
</table>
64+
65+
For more details on each command, run:
66+
67+
```bash
68+
version list
69+
```

0 commit comments

Comments
 (0)