From 3a7fd91a21a1b558b9188406370c1a30772f96e9 Mon Sep 17 00:00:00 2001
From: Dennis Meckel <meckel@datenschuppen.de>
Date: Sat, 24 Aug 2019 02:11:44 +0200
Subject: [PATCH] Documented benchmarks

---
 README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 83bcd22..cf53660 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ from flat file structures with implicit hierarchy.
   - [Development](#development)
 - [Licence](#licence)
 - [Setup](#setup)
+- [Benchmarks](#benchmarks)
 - [Tests](#tests)
 - [Usage](#usage)
   - [Search WzItem by ID](#search-wzitem-by-id)
@@ -90,6 +91,16 @@ composer require rayne/wz2008-graph
 * Clone the repository (see the [Tests](#tests) chapter)
 * Download a [zipped release](https://github.com/Rayne/wz2008-graph/releases)
 
+## Benchmarks
+
+It is recommended to call the `phpbench` program directly
+instead of using the provided `composer bench` script.
+The latter will kill the benchmark after five minutes.
+
+```bash
+./vendor/bin/phpbench run
+```
+
 ## Tests
 
 1.  Clone the repository
@@ -101,13 +112,13 @@ composer require rayne/wz2008-graph
 2.  Install the development dependencies
 
     ```bash
-    composer install --dev
+    composer install --dev --prefer-dist
     ```
 
 3.  Run the tests
 
     ```bash
-    ./vendor/bin/phpunit
+    composer test
     ```
 
 ## Usage