diff --git a/README.md b/README.md
index 6fe72b8..927fa62 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-
-
+
+
Yii Config
@@ -15,7 +15,7 @@
[![static analysis](https://github.com/yiisoft/config/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/config/actions?query=workflow%3A%22static+analysis%22)
[![type-coverage](https://shepherd.dev/github/yiisoft/config/coverage.svg)](https://shepherd.dev/github/yiisoft/config)
-This [Composer](https://getcomposer.org/) plugin provides assembling of configurations distributed with composer
+This [Composer](https://getcomposer.org) plugin provides assembling of configurations distributed with composer
packages. It is implementing a plugin system which allows to provide the configuration needed to use a package directly when installing it to make it run out-of-the-box.
The package becomes a plugin holding both the code and its default configuration.
@@ -108,25 +108,30 @@ The file paths are relative to the [source-directory](#source-directory), which
### Markers
- `?` - marks optional files. Absence of files not marked with this marker will cause exception.
+
```php
"params": [
"params.php",
"?params-local.php"
]
```
+
It's okay if `params-local.php` will not be found, but it's not okay if `params.php` will be absent.
- `*` - marks wildcard path. It means zero or more matches by wildcard mask.
+
```php
"web": [
"../src/Modules/*/config/web.php"
]
```
+
It will collect all `web.php` in any sub-folders of `src/Modules/` in `config` folder.
However, if the configuration folder is packaged as part of the `PHAR` archive, the configuration
files will not be uploaded. In this case, you must explicitly specify each configuration file.
- `$` - reference to another config by its group name.
+
```php
"params": [
"params.php",
@@ -141,6 +146,7 @@ The file paths are relative to the [source-directory](#source-directory), which
"params-web.php"
]
```
+
The config groups `params-console` and `params-web` will both contain the config values from `params.php` and `params-local.php` additional to their own configuration values.
***
@@ -664,7 +670,7 @@ Maintained by [Yii Software](https://www.yiiframework.com/).
## Credits
The plugin is heavily inspired by [Composer config plugin](https://github.com/yiisoft/composer-config-plugin)
-originally created by HiQDev (https://hiqdev.com/) in 2016 and then adopted by Yii.
+originally created by HiQDev () in 2016 and then adopted by Yii.
## Support the project
diff --git a/composer.json b/composer.json
index 7fd6953..d3a9f74 100644
--- a/composer.json
+++ b/composer.json
@@ -11,11 +11,11 @@
"license": "BSD-3-Clause",
"support": {
"issues": "https://github.com/yiisoft/config/issues?state=open",
+ "source": "https://github.com/yiisoft/config",
"forum": "https://www.yiiframework.com/forum/",
"wiki": "https://www.yiiframework.com/wiki/",
"irc": "ircs://irc.libera.chat:6697/yii",
- "chat": "https://t.me/yii3en",
- "source": "https://github.com/yiisoft/config"
+ "chat": "https://t.me/yii3en"
},
"funding": [
{
diff --git a/logo.png b/docs/logo.png
similarity index 100%
rename from logo.png
rename to docs/logo.png