Skip to content

Commit

Permalink
Docs: Clearly state supported type is required
Browse files Browse the repository at this point in the history
Custom paths cannot be defined for packages which do not use one of the supported types.
  • Loading branch information
naderman authored Nov 4, 2020
1 parent f69761f commit 9c9d1c0
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ So submit your packages to [packagist.org](http://packagist.org)!

## Custom Install Paths

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

```json
Expand All @@ -163,7 +163,9 @@ override the install path with the following extra in your `composer.json`:
}
```

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

``` json
{
Expand All @@ -175,8 +177,9 @@ A package type can have a custom installation path with a `type:` prefix.
}
```

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

``` json
{
Expand All @@ -188,8 +191,8 @@ using the `vendor:` prefix.
}
```

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

## Custom Install Names

Expand Down

0 comments on commit 9c9d1c0

Please sign in to comment.