Skip to content

Commit 009e41a

Browse files
authored
Update README.md
License updated Some changes in the description
1 parent 00182fa commit 009e41a

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# PHP Frameworks Bench
2-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/myaghobi/PHP-Frameworks-Bench?color=purpol) ![GitHub](https://img.shields.io/github/license/myaghobi/PHP-Frameworks-Bench?color=green)
2+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/myaaghubi/PHP-Frameworks-Bench?color=purpol) ![GitHub](https://img.shields.io/github/license/myaaghubi/PHP-Frameworks-Bench?color=green)
33

44
This project attempts to measure the minimum overhead (minimum bootstrap cost) of PHP frameworks in the real world.
55

66
So I think the minimum should not include:
77

8-
* cost of template engine (HTML output)
8+
* cost of template engine
99
* cost of database manipulation
1010
* cost of debugging information
1111

12-
Components like Template engines or ORM/Database libraries are out of scope in this project.
12+
Benchmarking on components like template engines or ORM/Database libraries is out of the scope of this project.
1313

1414

1515
- [PHP Frameworks Bench](#php-frameworks-bench)
@@ -75,26 +75,26 @@ This is `master` branch.
7575

7676
* Install a framework via `composer` according to the official documentation.
7777
* Use the default configuration.
78-
* Don't remove any components/configurations even if they are not used.
79-
* With minimum changes to run this benchmark.
80-
* Set environment production/Turn off debug mode.
78+
* Consider minimum changes to run the benchmark.
79+
* Don't remove any components/configurations even if there be no use for them.
80+
* Have a `controller` class for the `Hello World`, considering the default template of a controller of your framework.
81+
* Turn off `debug` mode and set environment to `production` mode.
8182
* Run the general optimization in your production environment, like `--optimize-autoloader` for the composer.
82-
* Use controller class.
8383

84-
Some frameworks are optimized, some are not, so some people may think using default configuration is not fair. The dept of optimizing a framework depends on the developer's experienced too, so it's the rabbit hole and there is no point in that for benchmarking. I think the default configuration of frameworks is a good starting point to have the ranking points.
84+
Some frameworks are optimized more than others, so some people may think using default configuration is not fair. The dept of optimizing a framework depends on the developer's experience too, so it's the rabbit hole and there is no point in it. I think the default configuration of frameworks is a good starting point to get ranking.
8585

86-
If you find something wrong with my code, feel free to send PR. But please note optimizing for the "Hello World" is not acceptable! Building the fastest "Hello World" application is not the goal of this project.
86+
If you find something wrong in my code, feel free to send a PR. But please note optimizing for the "Hello World" is not acceptable! Building the fastest `Hello World` application is not the goal of this project.
8787

8888

8989
## How to Benchmark
9090

91-
If you want to benchmark PHP extension frameworks like Phalcon, you need to install the extenstions.
91+
If you want to have benchmarks on `PHP extension frameworks` like Phalcon, you need to install the extension first based on its own documentation.
9292

93-
1- Download & install the library in your localhost:
93+
1- Download & install the library into your localhost:
9494

9595
```bash
9696
# you can put --branch vx.x
97-
$ git clone https://github.com/myaghobi/php-frameworks-bench.git
97+
$ git clone https://github.com/myaaghubi/php-frameworks-bench.git
9898

9999
$ cd php-frameworks-bench
100100

@@ -141,15 +141,17 @@ $ bash show-table.sh
141141
To specify the frameworks, put them after each command:
142142

143143
```bash
144+
# supported for `setup.sh`, `benchmark.sh`, `update.sh`, `clean.sh`, and `clear-cache.sh`
144145
$ bash benchmark.sh laravel-9.1/ slim-4.10/ fatfree-3.8.0/
145146
...
146147
```
147148

148149

149150
## References
150151
Note: This project is based on
151-
[php-framework-benchmark](https://github.com/kenjis/php-framework-benchmark). It was very old and abandoned, so I decided to split it from the origin and update it separately.
152+
[php-framework-benchmark](https://github.com/kenjis/php-framework-benchmark), thanks to [Kenjis](https://github.com/kenjis). It is very old and abandoned, so I decided to split it from the origin and update it separately.
152153

154+
For frameworks, I considered the official repos:
153155
* [CakePHP](https://github.com/cakephp/cakephp)
154156
* [CodeIgniter](https://github.com/codeigniter4/CodeIgniter4)
155157
* [FastRoute](https://github.com/nikic/FastRoute)
@@ -173,4 +175,4 @@ Note: This project is based on
173175

174176
You are allowed to use this plugin/project under the terms of the GNU General Public License version 2.
175177

176-
Copyright (C) 2022 Mohammad Yaghobi
178+
Copyright (C) 2023 Mohammad Yaaghubi

0 commit comments

Comments
 (0)