mirror of
https://github.com/yiisoft/yii2.git
synced 2026-02-20 00:32:19 +01:00
Update README.md to enhance logo display (light/dark) and badge styles. (#20562)
This commit is contained in:
37
README.md
37
README.md
@@ -1,6 +1,10 @@
|
||||
<p align="center">
|
||||
<a href="https://www.yiiframework.com/" target="_blank">
|
||||
<img src="https://www.yiiframework.com/image/yii_logo_light.svg" width="400" alt="Yii Framework" />
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://www.yiiframework.com/image/yii_logo_dark.svg">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://www.yiiframework.com/image/yii_logo_light.svg">
|
||||
<img src="https://www.yiiframework.com/image/yii_logo_light.svg" alt="Yii Framework" width="400">
|
||||
</picture>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@@ -9,17 +13,19 @@ Yii 2 is a modern framework designed to be a solid foundation for your PHP appli
|
||||
It is fast, secure and efficient and works right out of the box pre-configured with reasonable defaults.
|
||||
The framework is easy to adjust to meet your needs, because Yii has been designed to be flexible.
|
||||
|
||||
[](https://packagist.org/packages/yiisoft/yii2)
|
||||
[](https://packagist.org/packages/yiisoft/yii2)
|
||||
[](https://github.com/yiisoft/yii2/actions)
|
||||
[](https://codecov.io/gh/yiisoft/yii2)
|
||||
[](https://scrutinizer-ci.com/g/yiisoft/yii2/)
|
||||
[](https://packagist.org/packages/yiisoft/yii2)
|
||||
[](https://packagist.org/packages/yiisoft/yii2)
|
||||
[](https://github.com/yiisoft/yii2/actions/workflows/build.yml)
|
||||
[](https://github.com/yiisoft/yii2/actions/workflows/static.yml)
|
||||
[](https://codecov.io/gh/yiisoft/yii2)
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
- The minimum required PHP version of Yii is PHP 7.4.
|
||||
- It works best with PHP 8.
|
||||
> [!IMPORTANT]
|
||||
> - The minimum required [PHP](https://www.php.net/) version of Yii is PHP `7.4`.
|
||||
> - It works best with PHP `8`.
|
||||
|
||||
- [Follow the Definitive Guide](https://www.yiiframework.com/doc-2.0/guide-start-installation.html)
|
||||
in order to get step by step instructions.
|
||||
|
||||
@@ -37,7 +43,8 @@ to get an idea of what has changed in 2.0.
|
||||
Versions & PHP compatibility
|
||||
----------------------------
|
||||
|
||||
See ["Release Cycle" at the website](https://www.yiiframework.com/release-cycle).
|
||||
> [!NOTE]
|
||||
> See ["Release Cycle" at the website](https://www.yiiframework.com/release-cycle) for detailed information about supported versions.
|
||||
|
||||
Community
|
||||
---------
|
||||
@@ -63,6 +70,9 @@ You may join us and:
|
||||
|
||||
### Reporting Security issues
|
||||
|
||||
> [!WARNING]
|
||||
> Please do not report security vulnerabilities through public GitHub issues.
|
||||
|
||||
Please refer to a [special page at the website](https://www.yiiframework.com/security/)
|
||||
describing proper workflow for security issue reports.
|
||||
|
||||
@@ -87,18 +97,19 @@ we suggest using [our logo](https://www.yiiframework.com/logo/) on your title sl
|
||||
**In projects**
|
||||
|
||||
If you are using Yii 2 as part of an OpenSource project, a way to acknowledge it is to
|
||||
[use a special badge](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat) in your README:
|
||||
[use a special badge](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=for-the-badge&logo=yii) in your README:
|
||||
|
||||

|
||||
[](https://www.yiiframework.com/)
|
||||
|
||||
If your code is hosted at GitHub, you can place the following in your README.md file to get the badge:
|
||||
|
||||
```
|
||||
[](https://www.yiiframework.com/)
|
||||
[](https://www.yiiframework.com/)
|
||||
```
|
||||
|
||||
### Sponsoring
|
||||
|
||||
Support this project by becoming a sponsor or a backer.
|
||||
|
||||
[](https://opencollective.com/yiisoft) [](https://opencollective.com/yiisoft)
|
||||
[](https://opencollective.com/yiisoft)
|
||||
[](https://opencollective.com/yiisoft)
|
||||
|
||||
Reference in New Issue
Block a user