[sling-whiteboard] branch master updated: Complete the README

[bd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bdelacretaz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new e2f55d9  Complete the README
e2f55d9 is described below

commit e2f55d987f39e1c73790a3512df06853c98f14f7
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Mon Jul 15 14:37:10 2019 +0200

    Complete the README
---
 time-to-first-request/README.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/time-to-first-request/README.md b/time-to-first-request/README.md
index 00887e2..b0452fc 100644
--- a/time-to-first-request/README.md
+++ b/time-to-first-request/README.md
@@ -4,9 +4,27 @@ time-to-first-request
 This HTTP proxy, written in NodeJS, starts a Docker
 container on demand when an HTTP request is received.
 
-Used to measure the time-to-first-request on containers.
+It is used to measure the time-to-first-request on containers.
 
 To run this use:
 
     npm install
-    node index.js --help
+    node index.js
+
+With the default settings it says
+
+    listening on port 9000, proxying to http://127.0.0.1:8080 with httpd:2.4.39-alpine on port 8080/80
+    
+Which means that an HTTP request on port 9000 starts the `httpd:2.4.39-alpine` Docker image and proxies the request to its 8080 port, noting the timings when doing so:
+
+    Starting container: httpd:2.4.39-alpine(20.660ms)
+    Waiting on http://127.0.0.1:8080//index.html (23.164ms)
+    Time to wait for http://127.0.0.1:8080//index.html: (1.282s)
+    Proxying / (1.282s)
+    Done proxying (1.284s)
+
+The `/80` port is the one that the container exposes.
+
+The Docker image must be downloaded before running this, with `docker pull ...`.
+
+The `--help` option explains how to override the above values from the command-line.