Skip to content

Commit 1ee1372

Browse files
authored
Merge pull request #30 from siketyan/composer-bin
🔧 Prepare for publishing in Packagist
2 parents 0bf31d6 + 1c6d0af commit 1ee1372

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# loxcan
2+
[![Latest Stable Version](https://poser.pugx.org/siketyan/loxcan/v)](https://packagist.org/packages/siketyan/loxcan)
3+
[![Total Downloads](https://poser.pugx.org/siketyan/loxcan/downloads)](https://packagist.org/packages/siketyan/loxcan)
4+
[![License](https://poser.pugx.org/siketyan/loxcan/license)](https://packagist.org/packages/siketyan/loxcan)
25
![PHP](https://github.com/siketyan/loxcan/workflows/PHP/badge.svg)
36
![Action](https://github.com/siketyan/loxcan/workflows/Action/badge.svg)
47

@@ -24,7 +27,19 @@ Using this action, the added, upgraded, downgraded, and removed packages are rep
2427

2528
So we can check what packages will be changed by the PR, in the review.
2629

27-
## ✨ Installation
30+
## ✨ Usage
31+
### Via Composer
32+
```console
33+
$ composer require --dev siketyan/loxcan
34+
```
35+
36+
Then you can use this tool in CLI.
37+
(In some IDEs, you can access to the executable as just `loxcan` !)
38+
39+
```console
40+
$ ./vendor/bin/loxcan [base] [head]
41+
```
42+
2843
### In GitHub Actions
2944
Use `pull_request` events to trigger the action.
3045

composer.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,8 @@
4747
"@lint",
4848
"@test"
4949
]
50-
}
50+
},
51+
"bin": [
52+
"bin/loxcan"
53+
]
5154
}

0 commit comments

Comments
 (0)