about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--README.md14
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!