Skip to content

Commit 41373d0

Browse files
committed
Update readme for plugin-paths.
1 parent edb0f81 commit 41373d0

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
CakePHP Plugin Installer
2-
========================
1+
# CakePHP Plugin Installer
32

43
A composer installer for installing CakePHP 3.0+ plugins.
54

65
This installer ensures your application is aware of CakePHP plugins installed
76
by composer in `vendor/`.
87

9-
Usage
10-
-----
8+
## Usage
119

1210
Your CakePHP application should already depend on `cakephp/plugin-installer`, if
1311
not in your CakePHP application run:
@@ -23,6 +21,21 @@ only need to specify the `type` in their composer config:
2321
"type": "cakephp-plugin"
2422
```
2523

24+
## Multiple Plugin Paths
25+
26+
If your application uses multiple plugin paths. In addition to configuring your
27+
application settings you will also need to update your `composer.json` to ensure
28+
the generated `cakephp-plugins.php` file is correct:
29+
30+
```
31+
// Define the list of plugin-paths your application uses.
32+
"extra": {
33+
"plugin-paths": ["plugins", "extra_plugins"]
34+
}
35+
```
36+
37+
## Plugin Setup
38+
2639
For the installer to work properly ensure that your plugin's composer config
2740
file has a proper autoload section. Assuming your plugin's namespace is "MyPlugin"
2841
the autoload section would be like:

0 commit comments

Comments
 (0)