Skip to content

Commit 9c9d1c0

Browse files
authored
Docs: Clearly state supported type is required
Custom paths cannot be defined for packages which do not use one of the supported types.
1 parent f69761f commit 9c9d1c0

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ So submit your packages to [packagist.org](http://packagist.org)!
150150

151151
## Custom Install Paths
152152

153-
If you are consuming a package that uses the `composer/installers` you can
153+
If you are requiring a package which has one of the supported types you can
154154
override the install path with the following extra in your `composer.json`:
155155

156156
```json
@@ -163,7 +163,9 @@ override the install path with the following extra in your `composer.json`:
163163
}
164164
```
165165

166-
A package type can have a custom installation path with a `type:` prefix.
166+
You can determine a non-standard installation path for all packages of a
167+
particular type with the `type:` prefix. The type must be one of types
168+
listed on the supported list above.
167169

168170
``` json
169171
{
@@ -175,8 +177,9 @@ A package type can have a custom installation path with a `type:` prefix.
175177
}
176178
```
177179

178-
You can also have the same vendor packages with a custom installation path by
179-
using the `vendor:` prefix.
180+
You can also install all packages by a particular vendor to a custom
181+
installation path by using the `vendor:` prefix. The path will still
182+
only apply to packages by the vendor with a type in the supported list.
180183

181184
``` json
182185
{
@@ -188,8 +191,8 @@ using the `vendor:` prefix.
188191
}
189192
```
190193

191-
These would use your custom path for each of the listed packages. The available
192-
variables to use in your paths are: `{$name}`, `{$vendor}`, `{$type}`.
194+
These would use your custom path for each of the matching packages. The
195+
available variables to use in your paths are: `{$name}`, `{$vendor}`, `{$type}`.
193196

194197
## Custom Install Names
195198

0 commit comments

Comments
 (0)