Skip to content

Commit 3746882

Browse files
jianneijiannei
committed
docs: update readme
1 parent 420e0a3 commit 3746882

File tree

2 files changed

+50
-19
lines changed

2 files changed

+50
-19
lines changed

‎README-EN.md‎

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
> Provide a standardized and unified response data format for Laravel and Lumen API projects.
66
7+
> **🎉 Latest Update: Now supports Laravel 12!** Supports Laravel 5.5 ~ 12.x all versions, PHP 7.0 ~ 8.3.
8+
79
![Test](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)
810
[![StyleCI](https://github.styleci.io/repos/316969462/shield?style=flat&branch=main)](https://github.styleci.io/repos/316969462?style=flat&branch=main)
911
[![Latest Stable Version](https://poser.pugx.org/jiannei/laravel-response/v)](https://packagist.org/packages/jiannei/laravel-response)
@@ -33,15 +35,17 @@ Follow certain specifications, return HTTP status codes that are easy to underst
3335

3436
## Install
3537

36-
Support for laravel 5.5. *~ Laravel 10.*, the user-defined business operation code partially depends on [jiannei/laravel-enum](https://github.com/Jiannei/laravel-enum).
38+
Support for Laravel 5.5.* ~ Laravel 12.*, the user-defined business operation code partially depends on [jiannei/laravel-enum](https://github.com/Jiannei/laravel-enum).
3739

38-
| laravel version | lumen version | response version | enum version |
39-
|------------| ---- |-------------| ---- |
40-
| 5.5.* | 5.5.* | ~1.8 | ~1.4 |
41-
| 6.* | 6.* | ^2.0 | ~1.4 |
42-
| 7.* | 7.* | ^3.0 | ^2.0 |
43-
| 8.* | 8.* | ^4.0 | ^3.0 |
44-
| 9.* - 10.* | 9.* - 10.* | ^5.0 | ^3.0 |
40+
| laravel version | lumen version | response version | enum version | PHP version |
41+
|------------| ---- |-------------| ---- |------------|
42+
| 5.5.* | 5.5.* | ~1.8 | ~1.4 | ^7.0 |
43+
| 6.* | 6.* | ^2.0 | ~1.4 | ^7.2 |
44+
| 7.* | 7.* | ^3.0 | ^2.0 | ^7.2.5 |
45+
| 8.* | 8.* | ^4.0 | ^3.0 | ^7.3 |
46+
| 9.* - 10.* | 9.* - 10.* | ^5.0 | ^3.0 | ^8.0 |
47+
| 11.* | Not supported | ^6.0 | ^4.0 | ^8.2 |
48+
| 12.* | Not supported | ^6.0 | ^4.0 | ^8.2 |
4549

4650

4751
```shell
@@ -69,8 +73,23 @@ composer require jiannei/laravel-enum "^3.0" -vvv # optional
6973

7074
composer require jiannei/laravel-response "^5.0" -vvv
7175
composer require jiannei/laravel-enum "^3.0" -vvv # optional
76+
77+
# laravel 11.x
78+
79+
composer require jiannei/laravel-response "^6.0" -vvv
80+
composer require jiannei/laravel-enum "^4.0" -vvv # optional
81+
82+
# laravel 12.x
83+
84+
composer require jiannei/laravel-response "^6.0" -vvv
85+
composer require jiannei/laravel-enum "^4.0" -vvv # optional
7286
```
7387

88+
> **📝 Version Notes:**
89+
> - Laravel 11+ has built-in better exception handling mechanism, you can skip manual exception handling configuration
90+
> - Lumen is no longer maintained since Laravel 9, it's recommended to use Laravel for API development
91+
> - It's recommended to use the latest version for better performance and security
92+
7493
## Configuration
7594

7695
### Laravel
@@ -81,7 +100,7 @@ composer require jiannei/laravel-enum "^3.0" -vvv # optional
81100
$ php artisan vendor:publish --provider="Jiannei\Response\Laravel\Providers\LaravelServiceProvider"
82101
```
83102

84-
- format exception response
103+
- format exception response (Laravel 11+ can skip this step)
85104

86105
```php
87106
// app/Exceptions/Handler.php

‎README.md‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
> 为 Laravel 和 Lumen API 项目提供一个规范统一的响应数据格式。
66
7+
> **🎉 最新更新：现已支持 Laravel 12！** 支持 Laravel 5.5 ~ 12.x 全版本，PHP 7.0 ~ 8.3。
8+
79
![Test](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)
810
[![StyleCI](https://github.styleci.io/repos/316969462/shield?style=flat&branch=main)](https://github.styleci.io/repos/316969462?style=flat&branch=main)
911
[![Latest Stable Version](https://poser.pugx.org/jiannei/laravel-response/v)](https://packagist.org/packages/jiannei/laravel-response)
@@ -44,17 +46,22 @@
4446

4547
## 安装
4648

47-
支持 Laravel 5.5.* ~ Laravel 11.* 版本，自定义业务操作码部分依赖于 [jiannei/laravel-enum](https://github.com/Jiannei/laravel-enum)，需要先进行安装。
49+
支持 Laravel 5.5.* ~ Laravel 12.* 版本，自定义业务操作码部分依赖于 [jiannei/laravel-enum](https://github.com/Jiannei/laravel-enum)，需要先进行安装。
4850

49-
| laravel 版本 | lumen 版本 | response 版本 | enum 版本 |
50-
|------------|------------|-------------|---------|
51-
| 5.5.* | 5.5.* | ~1.8 | ~1.4 |
52-
| 6.* | 6.* | ^2.0 | ~1.4 |
53-
| 7.* | 7.* | ^3.0 | ^2.0 |
54-
| 8.* | 8.* | ^4.0 | ^3.0 |
55-
| 9.* - 10.* | 9.* - 10.* | ^5.0 | ^3.0 |
56-
| 11.* | 不支持 | ^6.0 | ^4.0 |
51+
| laravel 版本 | lumen 版本 | response 版本 | enum 版本 | PHP 版本要求 |
52+
|------------|------------|-------------|---------|------------|
53+
| 5.5.* | 5.5.* | ~1.8 | ~1.4 | ^7.0 |
54+
| 6.* | 6.* | ^2.0 | ~1.4 | ^7.2 |
55+
| 7.* | 7.* | ^3.0 | ^2.0 | ^7.2.5 |
56+
| 8.* | 8.* | ^4.0 | ^3.0 | ^7.3 |
57+
| 9.* - 10.* | 9.* - 10.* | ^5.0 | ^3.0 | ^8.0 |
58+
| 11.* | 不支持 | ^6.0 | ^4.0 | ^8.2 |
59+
| 12.* | 不支持 | ^6.0 | ^4.0 | ^8.2 |
5760

61+
> **📝 版本说明：**
62+
> - Laravel 11+ 版本内置了更好的异常处理机制，可以省略手动配置异常处理步骤
63+
> - Lumen 从 Laravel 9 开始不再维护，建议使用 Laravel 进行 API 开发
64+
> - 推荐使用最新版本以获得更好的性能和安全性
5865
5966
```shell
6067
# laravel 5.5
@@ -84,6 +91,11 @@ composer require jiannei/laravel-enum "^3.0" -vvv # 可选
8491

8592
# laravel 11.x
8693

94+
composer require jiannei/laravel-response "^6.0" -vvv
95+
composer require jiannei/laravel-enum "^4.0" -vvv # 可选
96+
97+
# laravel 12.x
98+
8799
composer require jiannei/laravel-response "^6.0" -vvv
88100
composer require jiannei/laravel-enum "^4.0" -vvv # 可选
89101
```
@@ -98,7 +110,7 @@ composer require jiannei/laravel-enum "^4.0" -vvv # 可选
98110
$ php artisan vendor:publish --provider="Jiannei\Response\Laravel\Providers\LaravelServiceProvider"
99111
```
100112

101-
- 格式化异常响应（laravel 11 可省略这一步）
113+
- 格式化异常响应（Laravel 11+ 可省略这一步）
102114

103115

104116
```php

0 commit comments

Comments
 (0)