Add intro section (#78)

* Add intro section * Remove introduction
cloudposse · Jul 16, 2018 · 8805648 · 8805648
1 parent ca37b4c
commit 8805648
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
 *Example of using the `build-harness` to build a docker image*
 
 
+
 ## Usage
 
 At the top of your `Makefile` add, the following...

diff --git a/README.yaml b/README.yaml
@@ -59,6 +59,10 @@ description: |-
   This `build-harness` is a collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more.
   It's designed to work with CI/CD systems such as Travis CI, CircleCI and Jenkins.
 
+# Introduction to the project
+#introduction: |-
+#  This is an introduction.
+
 # How to use this project
 usage: |-
   At the top of your `Makefile` add, the following...

diff --git a/templates/README.md b/templates/README.md
@@ -41,6 +41,11 @@ It's 100% Open Source and licensed under the [GNU General Public License](LICENS
 {{ range $screenshot := (ds "config").screenshots }}
 {{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }}
 {{ end }}
+{{ if has (ds "config") "introduction" }}
+## Introduction
+
+{{ (ds "config").introduction -}}
+{{ end }}
 {{ if has (ds "config") "usage" }}
 ## Usage
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,6 +30,7 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
		Example of using the `build-harness` to build a docker image



		## Usage

		At the top of your `Makefile` add, the following...
Expand Down