From e8434859ee55f290753f8be1a9e69b70d44f7f41 Mon Sep 17 00:00:00 2001
From: Alex <alexellis2@gmail.com>
Date: Thu, 22 Dec 2016 17:01:26 +0000
Subject: [PATCH] Initial readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 21a79503..f52872a7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # faas
 Functions as a service
+
+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.
+
+Features:
+
+* auto-scaling of replicas as load increases
+* backing off of replicas as load reduces
+* unique URL routes for serverless functions
+* instrumentation via Prometheus metrics at GET /metrics
+
+watchdog
+========
+
+This binary fwatchdog acts as a watchdog for your function. Features:
+
+* Static binary in Go
+* Listens to HTTP requests over swarm overlay network
+* Spawns process set in `fprocess` ENV variable for each HTTP connection
+* Only lets processes run for set duration i.e. 500ms, 2s, 3s.
+* Language/binding independent
+