Permalink
Browse files

Adds documentation for #52

  • Loading branch information...
weierophinney committed Feb 8, 2018
1 parent 6812352 commit ff8814698ebcf7f07c46028ca1863244180d898b
Showing with 53 additions and 0 deletions.
  1. +20 −0 README.md
  2. +33 −0 docs/book/index.html
View
@@ -64,3 +64,23 @@ one or more of the following keys under the `extra.zf` configuration in their
invokable that returns an array of configuration, and will be injected at the
top of:
- `config/config.php`
## Whitelisting packages to install automatically
At the project level, you can mark packages that expose configuration providers
and modules that you want to automatically inject via the `component-whitelist`
key:
```json
"extra": {
"zf": {
"component-whitelist": [
"zendframework/zend-expressive",
"zendframework/zend-expressive-helpers"
]
}
}
```
This configuration must be made at the root package level (the package
_consuming_ configuration providing packages).
View
@@ -218,6 +218,39 @@ <h2 class="panel-title">Global Installation</h2>
</div>
</div>
<div class="panel panel-success">
<div class="panel-heading">
<h2 class="panel-title">Whitelisting packages to autoinstall</h2>
</div>
<div class="panel-body">
<p>
At the root package level, you can indicate that certain packages
that supply config providers and/or modules should automatically
inject configuration, instead of prompting for installation, via
the "component-whitelist" setting. This value should be an array
of package names.
</p>
<pre><code class="lang-json" data-trim>
"extra": {
"zf": {
"component-whitelist": [
"zendframework/zend-expressive",
"zendframework/zend-expressive-helper",
"zendframework/zend-expressive-fastrouterouter",
"zendframework/zend-expressive-platesrenderer"
]
}
}
</code></pre>
<p>
This setting only works in the root package.
</p>
</div>
</div>
<div class="panel panel-info">
<div class="panel-heading">
<h2 class="panel-title">Why?</h2>

0 comments on commit ff88146

Please sign in to comment.