Skip to content

Commit 79e914b

Browse files
committed
Add composer-based installation line.
And improve README a little bit.
1 parent 9de98ad commit 79e914b

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# CliToolkit
22

3-
**CliToolkit** is a framework for PHP CLI scripts.
3+
**CliToolkit** is a CLI framework for PHP scripts.
44

5-
Key features (why would you want to use it):
5+
Key features (why you would want to use it):
66
- configure named (options) and positioned (arguments) parameters with ease using a builder;
77
- define required options, optional arguments, lists of possible values, flags, array-like parameters and subcommands;
88
- call your scripts from any paths by generated aliases
@@ -22,9 +22,12 @@ Key features (why would you want to use it):
2222

2323
The only requirement is PHP >= 8.1
2424

25-
Just clone / download this repository.
25+
Use composer:
26+
```shell
27+
composer require magic-push/cli-toolkit
28+
```
2629

27-
The composer-based installation will become available a bit later.
30+
... or just clone / download this repository.
2831

2932
## How to
3033

@@ -107,7 +110,8 @@ You can also read the [Tests](tests/Tests)`/*/scripts/` directories as artificia
107110
**CliToolkit** was inspired by and based on [Cliff](https://github.com/johnnywoo/cliff) project, so the first author is
108111
[Aleksandr Galkin](https://github.com/johnnywoo).
109112

110-
A part of ideas and code for **CliToolkit v1.0** was brought by [Anton Kotik](https://github.com/anton-kotik).
113+
A part of ideas and code for [CliToolkit v1.0.0](docs/changelog.md#v100) was brought by
114+
[Anton Kotik](https://github.com/anton-kotik).
111115

112116
The [Question](src/Question/Question.php) class was developed by [Vasiliy Borodin](https://github.com/borodin-vasiliy).
113117

0 commit comments

Comments
 (0)