diff options
author | Vincent Ambo <tazjin@gmail.com> | 2017-07-29T18·29+0200 |
---|---|---|
committer | Vincent Ambo <tazjin@gmail.com> | 2017-08-04T21·11+0200 |
commit | 658c6a9b0caedab65fea82e29e087aefdc8bf2f6 (patch) | |
tree | ec92dcd74b319c2ab135e182a6a4277037cc9a35 /README.md | |
parent | 5e7bb55e0018fafea01f6e99ff13c52ec33b24af (diff) |
docs README: Update feature list
Adds a feature list with links to individual feature description documents.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md index 2095cc8fee59..4a31cd69d6f5 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! |