From 7499b13030274ccc0a1610f2d7e41d1a3a722d7a Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 14:34:15 +0100 Subject: [PATCH] docs: Add headings and TOC Add missing heading names and a table of contents. Also, folded the long lines to make them easier to edit and diff. Fixes #501. Signed-off-by: James O. D. Hunt --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58e6230390..2231306b1e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ # Kata Containers packaging -Kata Containers currently supports packages for many distributions. Tooling to aid in creating these -packages are contained within this repository. +* [Introduction](#introduction) +* [Build in a container](#build-in-a-container) +* [Credits](#credits) -In addition, Kata build artifacts are available within a container image, created by a -[Dockerfile](kata-deploy/Dockerfile). Reference daemonsets are provided in [kata-deploy](kata-deploy), -which make installation of Kata Containers in a running Kubernetes Cluster very straightforward. +## Introduction + +Kata Containers currently supports packages for many distributions. Tooling to +aid in creating these packages are contained within this repository. + +## Build in a container + +Kata build artifacts are available within a container image, created by a +[Dockerfile](kata-deploy/Dockerfile). Reference daemonsets are provided in +[kata-deploy](kata-deploy), which make installation of Kata Containers in a +running Kubernetes Cluster very straightforward. ## Credits