summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorIan Lewis <ianlewis@google.com>2020-03-25 08:28:36 +0900
committerGitHub <noreply@github.com>2020-03-25 08:28:36 +0900
commitec51ea57e2a7ec6eb15200a7efd1dd6245381ec1 (patch)
tree56bd2513bd3d37fde0f4660de29c1c958cc1898b /README.md
parent8fbf811f79d611dd55355734736265dfec20b73f (diff)
Config docs (#54)
* Updated configuration docs to be more consistent * Add links to configuration docs * Add links to top README * Fix markdown formatting
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5480ab905..40a474c4f 100644
--- a/README.md
+++ b/README.md
@@ -7,14 +7,19 @@ gvisor-containerd-shim is a containerd shim for [gVisor](https://github.com/goog
## Requirements
-- gvisor (runsc) >= 2018-12-07
-- containerd, containerd-shim >= 1.1
+- gvisor (runsc) >= 2018-12-07
+- containerd, containerd-shim >= 1.1
## Installation
-- [Untrusted Workload Quick Start (containerd >=1.1)](docs/untrusted-workload-quickstart.md)
-- [Runtime Handler/RuntimeClass Quick Start (containerd >=1.2)](docs/runtime-handler-quickstart.md)
-- [Runtime Handler/RuntimeClass Quick Start (shim v2) (containerd >=1.2)](docs/runtime-handler-shim-v2-quickstart.md)
+- [Untrusted Workload Quick Start (containerd >=1.1)](docs/untrusted-workload-quickstart.md)
+- [Runtime Handler/RuntimeClass Quick Start (containerd >=1.2)](docs/runtime-handler-quickstart.md)
+- [Runtime Handler/RuntimeClass Quick Start (shim v2) (containerd >=1.2)](docs/runtime-handler-shim-v2-quickstart.md)
+
+## Configuration
+
+- [Configure containerd-shim-runsc-v1 (shim v2) (containerd >= 1.3)](docs/configure-containerd-shim-runsc-v1.md)
+- [Configure gvisor-containerd-shim (shim v1) (containerd &lt;= 1.2)](docs/configure-gvisor-containerd-shim.md)
# Contributing