From 9b3c82e720658b3ec7cc45ad7dfcf21add31ce36 Mon Sep 17 00:00:00 2001
From: eater <=@eater.me>
Date: Mon, 12 Nov 2018 23:33:47 +0100
Subject: [PATCH] Update readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cea67c1..a0f8e37 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,48 @@
 # Flavors
 
-A repository of different types of containers based on `d.xr.to/base`
+A repository of different types of containers based on `d.xr.to/base`, A list can be found under [Containers](#Containers)
+
+# Building
+
+Building of images is done by `flavor` a simple perl5 tool which automatically creates a dependency graph of containers and runs the builds in parallel if possible.
+
+```
+flavor [-h] [-r <repo>] [-x <images>] [-o] [-j <jobs>] [-p] [all|images...]
+
+Build Docker images with dependency graphing
+
+Options:
+    -x  Comma separated list of images not to rebuild in chain
+    -o  Only build given images, don't build parents
+    -r  Which repo or prefix to use, default: d.xr.to
+    -p  Push image after building
+    -j  How many builds should run at the same time, default: 4
+    -h  Show this help
+```
+
+## Example
+
+```
+[eater@momo flavors]$ ./flavor all
+INFO: building: nginx, php-fpm, php
+INFO: Starting build for nginx
+INFO: Starting build for php
+INFO: Finished build for php
+INFO: Starting build for php-fpm
+INFO: Finished build for nginx
+INFO: Finished build for php-fpm
+INFO: Done building!
+```
+
+# Containers
 
 |name||readme|description|
 |---|---|---|---|
 |php|`docker pull d.xr.to/php`||PHP, with composer installed and the following extensions: bz2, curl, gettext, gmp, openssl, pdo_mysql, pdo_sqlite, zip, and phar|
 |php-fpm|`docker pull d.xr.to/php-fpm`||`d.xr.to/php` with an php-fpm server running on port 9000|
 |nginx|`docker pull d.xr.to/nginx`|[README](nginx/)|A simple pre-configured nginx with safe defaults|
+
+# Todo
+
+- Support `img` in flavor
+- Add more containers (duh.)