From 658c6a9b0caedab65fea82e29e087aefdc8bf2f6 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sat, 29 Jul 2017 20:29:43 +0200 Subject: docs README: Update feature list Adds a feature list with links to individual feature description documents. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2095cc8fee..4a31cd69d6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,16 @@ cluster), but with the same deployment files. In my experience this is often enough and more complex solutions such as [Helm][] are not required. -## Overview +Check out a Kontemplate setup example and the feature list below! + +## Features + +* [Simple, yet powerful templates](docs/templates.md) +* [Clean cluster configuration files](docs/cluster-config.md) +* [Integration with pass](docs/pass.md) +* [Integration with kubectl](docs/kubectl.md) + +## Example Kontemplate lets you describe resources as you normally would in a simple folder structure: @@ -147,6 +156,9 @@ kontemplate apply example/prod-cluster.yaml --dry-run kontemplate apply example/prod-cluster.yaml ``` +Check out the feature list and the individual feature documentation above and read the +[best practices](docs/best-practices.md). Then you should be good to go! + ## Contributing Feel free to contribute pull requests, file bugs and open issues with feature suggestions! -- cgit 1.4.1