Add quickstart and adjust formatting of the README.
@@ -5,13 +5,62 @@ This project provides a way to run Docker containers as functions on Swarm Mode.
* Each container has a watchdog process that hosts a web server allowing a JSON post request to be forwarded to a desired process via STDIN. The respose is sent to the caller via STDOUT.
* A gateway provides a view to the containers/functions to the public Internet and collects metrics for Prometheus and in a future version will manage replicas and scale as throughput increases.
+## Quickstart
+
Minimum requirements:
-* Docker 1.13
-* Run `docker swarm init` to enable Docker Swarm Mode on your host. Multiple hosts are not required.
+* Docker 1.13-RC (to support attachable overlay networks)
+* At least a single host in Swarm Mode. (run `docker swarm init`)
+
+Check your `docker version` and upgrade to one of the latest 1.13-RCs from the [Docker Releases page](https://github.com/docker/docker/releases). This is already available through the Beta channel in Docker for Mac.
+
+#### Create an attachable network for the gateway and functions to join
+
+```
+# docker network create --driver overlay --attachable functions
+```
+
+#### Start the gateway
+
+```
+# docker pull alexellisio/faas-gateway:latest
+# docker rm -f gateway;
+# docker run -d -v /var/run/docker.sock:/var/run/docker.sock --name gateway -p 8080:8080 \
+ --network=functions alexellisio/faas-gateway:latest
+```
+
+#### Start at least one of the serverless functions:
+
+Here we start an echo service using the `cat` command found in a shell.
+
+```
+# docker service rm catservice
+# docker service create --network=functions --name catservice alexellisio/faas-catservice:latest
+```
+
+#### Now send an event to the API gateway
+
+* Method 1 - use the service name as a URL:
+
+```
+# curl -X POST --data-binary @$HOME/.ssh/known_hosts -v http://localhost:8080/function/catservice
+```
+
+* Method 2 - use the X-Function header:
+
+```
+# curl -X POST -H 'x-function: catservice' --data-binary @$HOME/.ssh/known_hosts -v http://localhost:8080/
+```
+
+#### Build your own function
+
+Visit the accompanying blog post to find out how to build your own function in whatever programming language you prefer.
-gateway
-=======
+[FaaS blog post](http://blog.alexellis.io/functions-as-a-service/)
+
+# Overview
+
+## the gateway
This container acts in a similar way to the API Gateway on AWS. Requests can be made to this endpoint with a JSON body.
@@ -30,8 +79,8 @@ Features:
* [todo] unique URL routes for serverless functions
* instrumentation via Prometheus metrics at GET /metrics
-watchdog
-========
+## the watchdog
+
This binary fwatchdog acts as a watchdog for your function. Features:
@@ -41,8 +90,7 @@ This binary fwatchdog acts as a watchdog for your function. Features:
* [todo] Only lets processes run for set duration i.e. 500ms, 2s, 3s.
* Language/binding independent
-Complete example:
-=================
+## Building a development environment:
To use multiple hosts you should push your services (functions) to the Docker Hub or a registry accessible to all nodes.
@@ -67,8 +115,6 @@ Accessing the `cat` (read echo) service:
# curl -X POST -H 'x-function: catservice' --data-binary @/etc/hostname -v http://localhost:8080/
```
-Prometheus metrics / instrumentation
-====================================
-
-* Standard go metrics and function invocation count / duration are available at http://localhost:8080/metrics/
+## Prometheus metrics / instrumentation
+Standard go metrics and function invocation count / duration are available at http://localhost:8080/metrics/
