Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
steevanb committed Apr 30, 2018
1 parent fc03f50 commit d51aa53
Showing 1 changed file with 13 additions and 21 deletions.
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,32 @@

## What is www.phpbenchmarks.com ?

You will find lot of benchmarks for PHP frameworks, ORM and libs here.
You will find lot of benchmarks for PHP frameworks and template engines.

You can compare results between Apache Bench and Siege, PHP 5.6 to 7.2 and versions of your favorites PHP code.
You can compare results between Apache Bench and Siege, and PHP 5.6 to 7.2.

## What is this repository ?

It's benchmark bundles for almost all Symfony versions.
It's benchmark common code for Symfony benchmarks.

As Symfony change `request` service to `request_stack` in Symfony 2.4, branches has been created for Symfony <= 2.3.
Switch branch to select your Symfony major version and benchmark you want to see.

Hello World: [helloworld](https://github.com/phpbenchmarks/symfony/tree/helloworld)
See all Symfony benchmarked versions on [phpbenchmarks/symfony](https://github.com/phpbenchmarks/symfony).

REST Api (Symfony 2.0 to 2.3): [restapi-symfony-2-3](https://github.com/phpbenchmarks/symfony/tree/restapi-symfony-2-3)
You can find how we benchmark on [phpbenchmarks.com](http://www.phpbenchmarks.com/en/benchmark-protocol.html).

REST Api (Symfony 2.4 to 4.x): [restapi](https://github.com/phpbenchmarks/symfony/tree/restapi)

Blog: [blog](https://github.com/phpbenchmarks/symfony/tree/blog)

Small overload: [smalloverload](https://github.com/phpbenchmarks/symfony/tree/smalloverload)

Big overload: [bigoverload](https://github.com/phpbenchmarks/symfony/tree/bigoverload)

You can find how we benchmark it [here](http://www.phpbenchmarks.com/en/benchmark-protocol).

## How version works ?
## How versions works ?

We do not follow semantic version for this repository. Here is an explanation about our versioning system:

`X` benchmark type (`1` Hello World, `2` Blog, `3` REST Api, `4` Small overload, `5` Big overload)
`X` related to Symfony major version (`2` Symfony ^2, `3` Symfony ^3, `4` Symfony ^4)

`Y` related to Symfony version (`0` Symfony 2.0 to 2.3, `1` Symfony 3.4 to 4.x for `REST Api` benchmak for example)
`Y` benchmark type (`1` Hello World, `3` Rest API, `4` Small overload)

`Z` new version, not just bugfix and could contains BC

## Symfony benchmarks
## Benchmarks

You can find all Symfony benchmarks results on [phpbenchmarks.com](http://www.phpbenchmarks.com/en/benchmark/symfony.html).

You can find all Symfony benchmarks [here](http://www.phpbenchmarks.com/en/benchmark/apache-bench/php-7.2/select-version/symfony.html).
Scores are too low ? Do not hesitate to create a pull request, and ask a new benchmark !

0 comments on commit d51aa53

Please sign in to comment.