Skip to content

Commit c45ef12

Browse files
committed
README update for versions
1 parent 85b2237 commit c45ef12

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,30 @@
88

99
A CakePHP plugin that provides a Shell to read an app's Configure vars from the command line.
1010

11-
* This is the Cake 3.x version of the plugin, which exists on the `master` branch and is tracked by the `~3.0` semver.
12-
* For the Cake 2.x version of this plugin, please use the repo's `cake-2.x` branch. (semver `~2.0`)
13-
* For the Cake 1.3 version, use the `cake-1.3` branch. (semver `~1.0`) **Note:** we don't expect to actively maintain or improve the 1.3 version. It's here because the project started life as a 1.3 Shell.
11+
## Installation
12+
Use the following as a guide for choosing your version based on the version of CakePHP installed.
13+
14+
| CakePHP | ConfigReadShell Plugin | Tag | Notes |
15+
| :-------------: | :------------------------: | :--: | :---- |
16+
| ^3.4 | [master](https://github.com/loadsys/CakePHP-ConfigReadShell/tree/master) | 4.0.0 | stable |
17+
| 3.3 | [3.3](https://github.com/loadsys/CakePHP-ConfigReadShell/tree/3.0.0) | 3.0.0 | stable |
18+
| 2.5 | [2.x](https://github.com/loadsys/CakePHP-ConfigReadShell/tree/2.0.1) | 2.0.1 | stable |
19+
| 1.3 | [1.x](https://github.com/loadsys/CakePHP-ConfigReadShell/tree/1.0.1) | 1.0.1 | stable |
20+
21+
22+
### This will install the latest version.
23+
```bash
24+
$ composer require loadsys/cakephp-config-read:~4.0
25+
```
1426

27+
**Note:** we don't expect to actively maintain or improve the 1.3 version. It's here because the project started life as a 1.3 Shell.
1528

1629
## Requirements
1730

1831
* PHP 7.0+
1932
* CakePHP 3.6.0+
2033

2134

22-
## Installation
23-
24-
```bash
25-
$ composer require loadsys/cakephp-config-read:~3.0
26-
```
27-
2835

2936
## Usage
3037

0 commit comments

Comments
 (0)