More details in README

[stouyapi.git] / README.rst

diff --git a/README.rst b/README.rst
index 785269d18658b1c8201b5aefaf4ca727860fc9f4..f5df7cf6697ba6b836f6837819d033d8ffefde0f 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -40,11 +40,36 @@ Virtual host configuration::
   Script PUT /empty-json.php
   Script DELETE /api/v1/queued_downloads_delete.php
 
-``mod_actions`` and ``mod_expires`` need to be enabled for apache 2.4.
+  <Directory "/path/to/stouyapi/www">
+    AllowOverride All
+  </Directory>
+
+``mod_actions``, ``mod_expires`` and ``mod_php`` (or php-fpm) need to be enabled
+for Apache 2.4.
 
 The virtual host's document root needs to point to the ``www`` folder.
 
 
+Test your Apache setup
+----------------------
+::
+
+   # check if normal API routes work
+   $ curl -I http://stouyapi.cwboo/api/firmware_builds
+   HTTP/1.1 200 OK
+   [...]
+
+   # check if rewritten API routes work
+   $ curl -I http://stouyapi.cwboo/api/v1/discover/discover
+   HTTP/1.1 200 OK
+   [...]
+
+   # check if PHP routes work
+   curl -I http://stouyapi.cwboo/api/v1/gamers/me
+   HTTP/1.1 200 OK
+   [...]
+
+
 Building API data
 =================
 Download the OUYA game data repository from