diff --git a/CHANGELOG.md b/CHANGELOG.md index 9215e92..f1f1189 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - Bug #146: Remove `yiisoft/yii2-symfonymailer` dependency from `composer.json` (@terabytesoftw) - Bug #149: Update PHPStan annotations and add container configuration file (@terabytesoftw) - Bug #150: Add container configuration to `console` app setup (@terabytesoftw) +- Bug #156: Update `README.md` with new Packagist badges and improve structure (@terabytesoftw) ## 0.1.0 August 31, 2025 diff --git a/README.md b/README.md index 8547fc6..c58baaa 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@

- + Yii Framework

Web Application Basic

+ + Latest Stable Version + PHP version @@ -42,13 +45,12 @@ A modern, Bootstrap 5-powered Yii2 application template designed for rapid web-a ## Available stacks +[![FrankenPHP Worker](https://img.shields.io/badge/frankenphp-blue?style=for-the-badge&label=worker&logo=php&logoColor=white)](https://github.com/yii2-extensions/app-basic/tree/franken-php) [![RoadRunner Worker](https://img.shields.io/badge/road%20runner-%23FF6B35.svg?style=for-the-badge&label=worker&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEyIDJMMjIgMTJMMTIgMjJMMiAxMkwxMiAyWiIgZmlsbD0iI0ZGNkIzNSIvPgo8cGF0aCBkPSJNMTIgNkwxOCAxMkwxMiAxOEw2IDEyTDEyIDZaIiBmaWxsPSIjRkZGRkZGIi8+CjxwYXRoIGQ9Ik0xMiA5TDE1IDEyTDEyIDE1TDkgMTJMMTIgOVoiIGZpbGw9IiNGRjZCMzUiLz4KPC9zdmc+&logoColor=white)](https://github.com/yii2-extensions/app-basic/tree/road-runner) For setup instructions, see README in each branch. -## Quick start - -### How it works +## How it works The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes. @@ -57,7 +59,7 @@ The Yii2 Web Application Basic template provides a complete foundation for build 3. **Security features** including CSRF protection and input validation. 4. **Development tools** for debugging, logging, and testing. -#### Why use this template +**Why use this template** - **Rapid development**: Start building features immediately without setup overhead. - **Best practices**: Follow Yii2 conventions and modern web development standards. @@ -68,17 +70,14 @@ The Yii2 Web Application Basic template provides a complete foundation for build ### Installation -[![Latest Stable Version](https://img.shields.io/packagist/v/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Stable)](https://packagist.org/packages/yii2-extensions/app-basic) -[![Total Downloads](https://img.shields.io/packagist/dt/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Downloads)](https://packagist.org/packages/yii2-extensions/app-basic) - -**Quick start** - ```bash -composer create-project --prefer-dist yii2-extensions/app-basic app-basic:^0.1 +composer create-project --prefer-dist yii2-extensions/app-basic:^0.1 app-basic cd app-basic ``` -**Start development server** +### Quick start + +Start development server ```bash # Using built-in PHP server @@ -88,6 +87,8 @@ php -S localhost:8080 -t web ./yii serve ``` +> Your application will be available at `http://localhost:8080` or at the address set in `--address` option. + ### Basic usage #### Directory structure @@ -146,6 +147,7 @@ final class SiteController extends Controller ``` ## Quality code +[![Total Downloads](https://img.shields.io/packagist/dt/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Downloads)](https://packagist.org/packages/yii2-extensions/app-basic) [![Codecov](https://img.shields.io/codecov/c/github/yii2-extensions/app-basic.svg?branch=main&style=for-the-badge&logo=codecov&logoColor=white&label=Coverage)](https://codecov.io/github/yii2-extensions/app-basic) [![PHPStan Level Max](https://img.shields.io/badge/PHPStan-Level%20Max-4F5D95.svg?style=for-the-badge&logo=php&logoColor=white)](https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml) [![StyleCI](https://img.shields.io/badge/StyleCI-Passed-44CC11.svg?style=for-the-badge&logo=styleci&logoColor=white)](https://github.styleci.io/repos/165419144?branch=main)