Skip to content

Commit 0ec3d3b

Browse files
author
Teppo Koivula
committed
Add instructions for customizing installer paths
1 parent 3eedae4 commit 0ec3d3b

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
@@ -34,6 +34,22 @@ There's a very similar project you might've heard of, called `hari/pw-module`. W
3434

3535
*Note that in order for this work, the module or site profile in question has to have `wireframe-framework/processwire-composer-installer` as a dependency. See next section for instructions for module or site profile authors.*
3636

37+
#### Customizing installer paths
38+
39+
By default site profiles are installed under current working directory, and modules under site/modules/ (or modules/ in case you're already in a site directory). You can, though, override the default paths in the root composer.json of your project:
40+
41+
```
42+
{
43+
"require": {
44+
...
45+
},
46+
"extra": {
47+
"pw-module-path": "site/modules",
48+
"pw-site-profile-path": "",
49+
}
50+
}
51+
```
52+
3753
### For module or site profile authors
3854

3955
The usage of this project is rather simple. You just need to a) add `wireframe-framework/processwire-composer-installer` as a dependency to your project by manually modifying the composer.json file or by running `composer require wireframe-framework/processwire-composer-installer` in your module or site profile root directory, and b) define the type of your package (via composer.json) as `pw-module` (for modules) or `pw-site-profile` (for site profiles).

0 commit comments

Comments
 (0)