From b9c9ad94cf4fc7c8e1658a9887db444f76c166fb Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Thu, 17 May 2018 10:29:47 -0700 Subject: [PATCH] docs: update README to include links to user guides Added links to the installation guides, as well as a pointer to the kata containers architecutre document. Fixes: #315 Signed-off-by: Eric Ernst --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6a66b6bbe7..cdfa9fea6e 100644 --- a/README.md +++ b/README.md @@ -65,11 +65,21 @@ $ kata-runtime kata-check > $ sudo kata-runtime kata-check > ``` +## Quick start for users + +See the [installation guides](https://github.com/kata-containers/documentation/tree/master/install/README.md) +available for various operating systems. + ## Quick start for developers See the [developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md). +## Architecture overview + +See the [architecture overview](https://github.com/kata-containers/documentation/blob/master/architecture.md) +for details on the Kata Containers design. + ## Configuration The runtime uses a TOML format configuration file called `configuration.toml`.