Skip to content

Commit d9c5413

Browse files
fix(app): Update README.md with new Packagist badges and improve structure. (#156)
1 parent e21d700 commit d9c5413

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Bug #146: Remove `yiisoft/yii2-symfonymailer` dependency from `composer.json` (@terabytesoftw)
88
- Bug #149: Update PHPStan annotations and add container configuration file (@terabytesoftw)
99
- Bug #150: Add container configuration to `console` app setup (@terabytesoftw)
10+
- Bug #156: Update `README.md` with new Packagist badges and improve structure (@terabytesoftw)
1011

1112
## 0.1.0 August 31, 2025
1213

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<p align="center">
2-
<a href="https://github.com/yii2-extensions/localeurls" target="_blank">
2+
<a href="https://github.com/yii2-extensions/app-basic" target="_blank">
33
<img src="https://www.yiiframework.com/image/yii_logo_light.svg" alt="Yii Framework">
44
</a>
55
<h1 align="center">Web Application Basic</h1>
66
</p>
77

88
<p align="center">
9+
<a href="https://packagist.org/packages/yii2-extensions/app-basic" target="_blank">
10+
<img src="https://img.shields.io/packagist/v/yii2-extensions/app-basic.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Stable" alt="Latest Stable Version">
11+
</a>
912
<a href="https://www.php.net/releases/8.1/en.php" target="_blank">
1013
<img src="https://img.shields.io/badge/%3E%3D8.1-777BB4.svg?style=for-the-badge&logo=php&logoColor=white" alt="PHP version">
1114
</a>
@@ -42,13 +45,12 @@ A modern, Bootstrap 5-powered Yii2 application template designed for rapid web-a
4245

4346
## Available stacks
4447

48+
[![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)
4549
[![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)
4650

4751
For setup instructions, see README in each branch.
4852

49-
## Quick start
50-
51-
### How it works
53+
## How it works
5254

5355
The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes.
5456

@@ -57,7 +59,7 @@ The Yii2 Web Application Basic template provides a complete foundation for build
5759
3. **Security features** including CSRF protection and input validation.
5860
4. **Development tools** for debugging, logging, and testing.
5961

60-
#### Why use this template
62+
**Why use this template**
6163

6264
- **Rapid development**: Start building features immediately without setup overhead.
6365
- **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
6870
6971
### Installation
7072

71-
[![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)
72-
[![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)
73-
74-
**Quick start**
75-
7673
```bash
77-
composer create-project --prefer-dist yii2-extensions/app-basic app-basic:^0.1
74+
composer create-project --prefer-dist yii2-extensions/app-basic:^0.1 app-basic
7875
cd app-basic
7976
```
8077

81-
**Start development server**
78+
### Quick start
79+
80+
Start development server
8281

8382
```bash
8483
# Using built-in PHP server
@@ -88,6 +87,8 @@ php -S localhost:8080 -t web
8887
./yii serve
8988
```
9089

90+
> Your application will be available at `http://localhost:8080` or at the address set in `--address` option.
91+
9192
### Basic usage
9293

9394
#### Directory structure
@@ -146,6 +147,7 @@ final class SiteController extends Controller
146147
```
147148
## Quality code
148149

150+
[![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)
149151
[![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)
150152
[![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)
151153
[![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)

0 commit comments

Comments
 (0)