Improve readme (#389)

vjik · samdark · web-flow · commit ae69a604c6a4 · 2025-08-22T12:32:14.000+03:00
Co-authored-by: Alexander Makarov &lt;sam@rmcreative.ru&gt;
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
     <a href="https://github.com/yiisoft" target="_blank">
         <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
     </a>
-    <h1 align="center">Yii Application Template</h1>
-    <h3 align="center">Application template for Yii 3 is best for rapidly creating projects</h3>
+    <h1 align="center">Yii3 web application</h1>
+    <h3 align="center">An application template for a new web project</h3>
     <br>
 </p>
 
@@ -14,40 +14,46 @@
 [![static analysis](https://github.com/yiisoft/app/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/app/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/app/coverage.svg)](https://shepherd.dev/github/yiisoft/app)
 
-Web application template for Yii 3.
-
-<p align="center">
+<p>
     <a href="https://github.com/yiisoft/app" target="_blank">
-        <img src="docs/images/home.png" alt="Home page" >
+        <img src="docs/images/home.png" alt="Home page">
     </a>
 </p>
 
+The package is a classic web application template. If you need console only or API please start with corresponding
+templates:
+
+- [Console application template](https://github.com/yiisoft/app-console)
+- [API application template](https://github.com/yiisoft/app-api)
+
 ## Requirements
 
-- PHP 8.1 or higher.
+- PHP 8.2 or higher.
+
+## Installation
 
-## Local installation
+### Local installation
 
 If you do not have [Composer](https://getcomposer.org/), you may install it by following the instructions
 at [getcomposer.org](https://getcomposer.org/doc/00-intro.md).
 
 Create a project:
 
 ```shell
-composer create-project --stability=dev yiisoft/app myproject
+composer create-project yiisoft/app myproject
 cd myproject
 ```
 
 To run the app:
 
-```
+```shell
 APP_ENV=dev ./yii serve
 ```
 
 Now you should be able to access the application through the URL printed to console.
 Usually it is `http://localhost:8080`.
 
-## Installation with Docker
+### Installation with Docker
 
 Fork the repository, clone it, then:
 
@@ -70,156 +76,44 @@ make down
 
 The application is available at `https://localhost`.
 
-## Directory structure
-
-The application template has the following structure:
-
-```
-config/             Configuration files.
-docker/             Docker-specific files.
-docs/               Documentation.
-public/             Files publically accessible from the Internet.
-    assets/         Published assets.
-    index.php       Entry script.
-resources/          Application resources.
-    assets/         Asset bundle resources.
-    layout/         Layout view templates.
-    messages/
-    views/          View templates.
-runtime/            Files generated during runtime.
-src/                Application source code.
-    Asset/          Asset bundle definitions.
-    Command/        Console commands.
-    Controller/     Web controller classes.
-    EventHandler/
-    Handler/
-    ViewInjection/
-tests/              A set of Codeception tests for the application.
-vendor/             Installed Composer packages.
-Makefile            Config for make command.
-```
-
-## Configuration
-
-You can find configuration in `config` directory. There are multiple configs,
-and the most interesting is `common\params.php`. Below there are details about its sections:
-
-### Application Services
-
-There are multiple pre-configured application services.
-
-#### Aliases
+Other make commands are available in the `Makefile` and can be listed with:
 
-```php
-'yiisoft/aliases' => [
-    'aliases' => [
-        // standard directory aliases
-        '@root' => dirname(__DIR__),
-        '@assets' => '@root/public/assets',
-        '@assetsUrl' => '/assets',
-        '@public' => '@root/public',
-        '@resources' => '@root/resources',
-        '@runtime' => '@root/runtime',
-    ],
-],
-```
-
-See ["Aliases"](https://github.com/yiisoft/docs/blob/master/guide/en/concept/aliases.md) in the guide.
-
-#### Cache
-
-```php
-'yiisoft/cache-file' => [
-    'file-cache' => [
-        // cache directory path
-        'path' => '@runtime/cache'
-    ],
-],
-```
-
-#### Log Target File
-
-```php
-use Psr\Log\LogLevel;
-
-'yiisoft/log-target-file' => [
-    'file-target' => [
-        // route directory file log
-        'file' => '@runtime/logs/app.log',
-        // levels logs target
-        'levels' => [
-            LogLevel::EMERGENCY,
-            LogLevel::ERROR,
-            LogLevel::WARNING,
-            LogLevel::INFO,
-            LogLevel::DEBUG,
-        ],
-    ],
-    'file-rotator' => [
-        // maximum file size, in kilobytes. Defaults to 10240, meaning 10MB.
-        'maxFileSize' => 10240,
-        // number of files used for rotation. Defaults to 5.
-        'maxFiles' => 5,
-        // the permission to be set for newly created files.
-        'fileMode' => null,
-        // Whether to rotate files by copy and truncate in contrast to rotation by renaming files.
-        'compressRotatedFiles' => null
-    ],
-],
-```
-
-See ["Logging"](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/logging.md) in the guide.
-
-#### Session
-
-```php
-'yiisoft/session' => [
-    'session' => [
-        // options for cookies
-        'options' => ['cookie_secure' => 0],
-        // session handler
-        'handler' => null
-    ],
-],
+```shell
+make help
 ```
 
-#### View
-
-```php
-'yiisoft/view' => [
-    // Custom parameters that are shared among view templates.
-    'defaultParameters' => [
-        'applicationParams' => 'App\ApplicationParams',
-        'assetManager' => 'Yiisoft\Assets\AssetManager',
-    ],
-    'theme' => [
-        // Apply pathMap example: ['@resources/layout' => '@resources/theme'] in yiisoft/app
-        // Apply pathMap example: ['@resources/layout' => '@modulealiases/theme'] in module
-        'pathMap' => [],
-        'basePath' => '',
-        'baseUrl' => '',
-    ],    
-],
-
-```
+## Directory structure
 
-#### Yii Debug
+The application template has the following structure:
 
-```php
-'yiisoft/yii-debug' => [
-    // enabled/disabled debugger
-    'enabled' => true
-],
 ```
-
-#### Application Layout Parameters
-
-```php
-'app' => [
-    'charset' => 'UTF-8',
-    'language' => 'en',
-    'name' => 'My Project',
-],
+assets/                     Asset bundle source files.
+config/                     Configuration files.
+    common/                 Common configuration and DI definitions.
+    console/                Console-specific configuration.
+    environments/           Environment-specific configuration (dev/test/prod).
+    web/                    Web-specific configuration.
+docker/                     Docker-specific files.
+docs/                       Documentation.
+public/                     Files publically accessible from the Internet.
+    assets/                 Published/compiled assets.
+    index.php               Entry script.
+runtime/                    Files generated during runtime.
+src/                        Application source code.
+    Command/                Console commands.
+    Controller/             Web controller classes with templates.
+    Handler/                Request handlers (e.g., NotFound).
+    Layout/                 Layout components and templates.
+    ApplicationParams.php   Application parameters class.
+    Environment.php         Environment configuration class.
+tests/                      A set of Codeception tests for the application.
+    Console/                Console command tests.
+    Functional/             Functional tests.
+    Unit/                   Unit tests.
+    Web/                    Web interface tests.
+vendor/                     Installed Composer packages.
+Makefile                    Config for make command.
+yii                         Console application entry point.
 ```
 
 ## Testing
@@ -238,7 +132,6 @@ For Docker:
 
 ```shell
 make codecept build
-
 make codecept run
 ```
 
@@ -258,12 +151,11 @@ make psalm
 
 ## Support
 
-If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
-You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
+If you need help or have a question, check out [Yii Community Resources](https://www.yiiframework.com/community).
 
 ## License
 
-The Yii application template is free software. It is released under the terms of the BSD License.
+The Yii3 web application template is free software. It is released under the terms of the BSD License.
 Please see [`LICENSE`](./LICENSE.md) for more information.
 
 Maintained by [Yii Software](https://www.yiiframework.com/).
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "yiisoft/app",
     "type": "project",
-    "description": "Yii3 application template",
+    "description": "Yii3 web application template",
     "keywords": [
         "yii3",
         "app"
diff --git a/docs/images/home.png b/docs/images/home.png

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "yiisoft/app",`
`3`	`3`	`"type": "project",`
`4`		`- "description": "Yii3 application template",`
	`4`	`+ "description": "Yii3 web application template",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"yii3",`
`7`	`7`	`"app"`