Added README

dantleech · dantleech · commit c446aaa8e64c · 2015-05-08T11:22:17.000+02:00
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
+PHPCR Benchmarks
+================
+
+Benchmarking suite for PHPCR which uses the same bootstrapping process as the
+[PHPCR-API-tests](https://github.com/phpcr/phpcr-api-tests).
+
+Usage
+-----
+
+Ensure that the PHPCR-API tests are working.
+
+Include as a dev requirement:
+
+````bash
+$ composer require "phpcr/phpcr-benchmarks"
+````
+
+Run:
+
+````bash
+$ ./vendor/bin/phpbench ./vendor/phpcr/phpcr-benchmarks/benchmarks
+````
+
+With detailed report:
+
+````bash
+$ ./vendor/bin/phpbench ./vendor/phpcr/phpcr-benchmarks/benchmarks \
+    --report={"name": "console_table", "memory": true}
+````
+
+With a filter:
+
+````bash
+$ ./vendor/bin/phpbench ./vendor/phpcr/phpcr-benchmarks/benchmarks \
+    --report=console_table
+    --filter=benchInsert
+````
+
+For more information see the documentation for [PHPBench](https://github.com/dantleech/phpbench).
+
diff --git a/composer.json b/composer.json
@@ -15,7 +15,7 @@
     },
     "autoload": {
         "psr-4": {
-            "PHPCR\Benchmark\": "benchmarks"
+            "PHPCR\\Benchmark\\": "benchmarks"
         }
     }
 }
