version 2 and bugfixes

README.md

@@ -14,30 +14,116 @@ curl https://raw.githubusercontent.com/SergiX44/php-benchmark-script/master/benc
 
 Or upload the file `bench.php` to your web document root and visit it.
 
-# Example Output
+#### Parameters
+
+You can change the difficulty multiplier by passing a `multiplier` parameter:
+
+```sh
+php bench.php --multiplier=2
 ```
---------------------------------------------------
-|    PHP BENCHMARK SCRIPT v.1.0 by @SergiX44     |
---------------------------------------------------
-PHP version................................. 8.2.1
-Platform.................................... Linux
-Server:.................................. hostname
-OPCache status:........................... enabled
-OPCache JIT:.............................. enabled
-PCRE JIT:................................. enabled
-Started at:............... 17/01/2023 15:22:51.079
---------------------------------------------------
-math..................................... 0.1551 s
-loops.................................... 0.0223 s
-ifelse................................... 0.0305 s
-switch................................... 0.0283 s
-strings.................................. 0.4240 s
-array.................................... 0.7684 s
-regex.................................... 0.2929 s
-is_{type}................................ 0.0611 s
---------------------------------------------------
-Total time............................... 1.7828 s
-Peak memory usage........................... 2 MiB
+
+### Additional tests
+
+You must have the `bench.php` file to your server.
+You can download additional benchmarks (must be in the same directory as `bench.php`) using:
+
+```sh
+# rand: random number generation
+wget https://raw.githubusercontent.com/SergiX44/php-benchmark-script/master/rand.bench.php
+```
+
+Then you can run the benchmark using:
+
+```sh
+php bench.php
+```
+
+If the file is in the same directory as `bench.php`, it will be automatically loaded.
+
+## Custom tests
+
+You can create your own tests by creating a file in the same directory as `bench.php` and the file must be
+named `*.bench.php`.
+
+The file must return a closure, or an array of closures. Each closure should take a parameter `$multiplier` which is
+how hard the test should be. The higher the `$multiplier`, the longer the test will take, by default it is `1`.
+You should choose a reasonable number of iterations for your test (e.g. 1000) and multiply it by the `$multiplier`.
+
+Example:
+
+```php
+// mytest.bench.php
+
+return function ($multiplier = 1) {
+    $iterations = 1000 * $multiplier;
+    for ($i = 0; $i < $iterations; ++$i) {
+        // do something
+    }
+};
+```
+
+Or with multiple tests:
+
+```php
+// mytest.bench.php
+
+return [
+    'my_test' => function ($multiplier = 1) {
+        $iterations = 1000 * $multiplier;
+        for ($i = 0; $i < $iterations; ++$i) {
+            // do something
+        }
+    },
+    'another_test' => function ($multiplier = 1) {
+        $iterations = 1000 * $multiplier;
+        for ($i = 0; $i < $iterations; ++$i) {
+            // do something else
+        }
+    },
+];
+```
+
+# Example Output
+
+```sh
+-------------------------------------------------------
+|       PHP BENCHMARK SCRIPT v.2.0 by @SergiX44       |
+-------------------------------------------------------
+PHP............................................. 8.2.10
+Platform........................................ Darwin
+Arch............................................. arm64
+Server........................................ hostname
+Max memory usage.................................. 512M
+OPCache status................................. enabled
+OPCache JIT.................................... enabled
+PCRE JIT....................................... enabled
+XDebug extension.............................. disabled
+Difficulty multiplier............................... 1x
+Started at..................... 06/12/2023 13:45:37.453
+-------------------------------------------------------
+math.......................................... 0.0935 s
+loops......................................... 0.0121 s
+ifelse........................................ 0.0173 s
+switch........................................ 0.0172 s
+string........................................ 0.1842 s
+array......................................... 0.3212 s
+regex......................................... 0.1769 s
+is_{type}..................................... 0.0322 s
+hash.......................................... 0.1202 s
+json.......................................... 0.1586 s
+-----------------Additional Benchmarks-----------------
+io::file_read................................. 0.0129 s
+io::file_write................................ 0.0715 s
+io::file_zip.................................. 0.5335 s
+io::file_unzip................................ 0.1571 s
+rand::rand.................................... 0.0089 s
+rand::mt_rand................................. 0.0089 s
+rand::random_int.............................. 0.0679 s
+rand::random_bytes............................ 0.2320 s
+rand::openssl_random_pseudo_bytes............. 0.2953 s
+-------------------------------------------------------
+Total time.................................... 2.5214 s
+Peak memory usage................................ 2 MiB
 ```
 
 ## Authors