Merge remote-tracking branch 'origin/master'

README.md

@@ -1,35 +1,45 @@
 # tumbo
 
-Docker matrix build generator
+Docker matrix build generator.
+
+The basic idea is that you combine a config file with custom variables with templating (Jinja2) and *__tumbo__* will run your matrix build in docker.
+
+## 🚀 Quickstart
+
+###### spec.yml
 
 ```yaml
 variables:
-    my_var:
+    version:
-        - a
+        - 3.11
-        - b
+        - 3.10
-        - c
+        - 3.9
-    some_other:
+    name:
-        - 0.1.0
+        - Alice
-        - 0.1.2
+        - Bob
 
-context: ./build
+recipe: ./Dockerfile.j2
-recipe: './Dockerfile.j2'
-tag: "my-tag:{{ my_var }}-{{ some_other }}"
 
-parallel: no
-# no
-# yes : uses all threads available
-# n : number of threads to use
-# default: yes
-
-push: yes
 run: yes
-registry:
+parallel: no
-    username: my_user
-    password: my_pass
-    host: my_host
 ```
 
+###### Dockerfile.j2
+
+```
+FROM alpine:{{ version }}
+
+CMD [ "echo", "Hi {{ name }} from {{ version }}" ]
+```
+
+And run
+
+```sh
+tumbo -c spec.yml
+```
+
+Tumbo will then generate 6 images, build and run them in all the combinations possible with the variables given.
+
 ## 📘 Config Reference
 
 ### Variables