Skip to content

Commit 94fad28

Browse files
committed
Added "Getting started" section to the README.md.
1 parent b9f3453 commit 94fad28

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ The command line utility will use an existing `git` repository to compare to cha
1212

1313
**Note** It is strongly suggested you do not run this directly on any repository you do not want to lose. Make a copy of it beforehand and run `php-semver-checker-git` on that copy instead.
1414

15+
## Getting started
16+
17+
1. Install `php-semver-checker-git` through composer, either globally or locally:
18+
19+
Locally
20+
```bash
21+
php composer require --dev tomzx/php-semver-checker-git
22+
```
23+
24+
Globally
25+
```bash
26+
php composer global require tomzx/php-semver-checker-git
27+
```
28+
29+
See the example section for examples of how to use the tool.
30+
1531
## Example
1632

1733
```bash

0 commit comments

Comments
 (0)