From 4b1f0b88eb22fd5c204afe929ae617ccd7fb48ad Mon Sep 17 00:00:00 2001 From: Jeff Nickoloff Date: Wed, 5 Jul 2017 10:36:44 -0700 Subject: [PATCH] Added docs links to README Signed-off-by: Jeff Nickoloff --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index fd845d5..571e142 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # v2c - An image analysis and provisioning workflow +## Documentation + +* [Building components - enhancing the tool](docs/BUILDING-COMPONENTS.md) +* [Program architecture and how components work together](docs/DESIGN-AND-INTERFACES.md) + ## Demo This codebase ships with a demo of the proof of concept. The goal of the proof of contept was to demonstrate a workflow that shares the contents of a VMDK with a set of detective components which contribute material to a set of referenced image provisioners. Those provisioners transform the detective contributed materials and contribute Dockerfile segments. All of these contributions tar streamed via tar. The workflow finally stiches together contributed Dockerfile segments into a single Dockerfile and persists an expanded build context. The proof of concept does not perform final image assembly or actually use a real input image, detectives, or provisioners. Those components are crafted to demonstrate material contribution flow.