[cherry-pick] Generate README.md using templates (#512) (#519)

/cherry-pick Signed-off-by: Tamal Saha <[email protected]> Co-authored-by: Tamal Saha <[email protected]>
stashed · Dec 25, 2020 · 66da057 · 66da057
1 parent a5be388
commit 66da057
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -266,6 +266,11 @@ gen-values-schema: $(BUILD_DIRS)
 		rm -rf bin/values.openapiv3_schema.yaml; \
 	done
 
+.PHONY: gen-readme
+gen-readme:
+	jq -n -c --arg v "$(CHART_VERSION)" '{"version":$$v}' > /tmp/data.json
+	render-gotpl --template=hack/templates/readme.txt --data=/tmp/data.json > README.md
+
 .PHONY: gen-chart-doc
 gen-chart-doc: gen-chart-doc-stash-postgres
 

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Install PostgreSQL 11.2 backup or restore plugin for Stash as below.
 ```console
 helm repo add appscode https://charts.appscode.com/stable/
 helm repo update
-helm install appscode/stash-postgres --name=stash-postgres-11.2 --version=11.2
+helm install stash-postgres-11.2-v2 appscode/stash-postgres --version=11.2-v2
 ```
 
 To install catalog for all supported PostgreSQL versions, please visit [here](https://github.com/stashed/catalog).
@@ -25,7 +25,7 @@ To install catalog for all supported PostgreSQL versions, please visit [here](ht
 Uninstall PostgreSQL 11.2 backup or restore plugin for Stash as below.
 
 ```console
-helm delete stash-postgres-11.2
+helm delete stash-postgres-11.2-v2
 ```
 
 ## Support

diff --git a/hack/templates/readme.txt b/hack/templates/readme.txt
@@ -0,0 +1,41 @@
+[![Go Report Card](https://goreportcard.com/badge/stash.appscode.dev/postgres)](https://goreportcard.com/report/stash.appscode.dev/postgres)
+![CI](https://github.com/stashed/postgres/workflows/CI/badge.svg)
+[![Docker Pulls](https://img.shields.io/docker/pulls/stashed/stash-postgres.svg)](https://hub.docker.com/r/stashed/stash-postgres/)
+[![Slack](https://slack.appscode.com/badge.svg)](https://slack.appscode.com)
+[![Twitter](https://img.shields.io/twitter/follow/kubestash.svg?style=social&logo=twitter&label=Follow)](https://twitter.com/intent/follow?screen_name=KubeStash)
+
+{{ $v := semver .version -}}
+
+# Postgres
+
+Postgres backup and restore plugin for [Stash by AppsCode](https://stash.run).
+
+## Install
+
+Install PostgreSQL {{ $v.Major }}.{{ $v.Minor }} backup or restore plugin for Stash as below.
+
+```console
+helm repo add appscode https://charts.appscode.com/stable/
+helm repo update
+helm install stash-postgres-{{ .version }} appscode/stash-postgres --version={{ .version }}
+```
+
+To install catalog for all supported PostgreSQL versions, please visit [here](https://github.com/stashed/catalog).
+
+## Uninstall
+
+Uninstall PostgreSQL {{ $v.Major }}.{{ $v.Minor }} backup or restore plugin for Stash as below.
+
+```console
+helm delete stash-postgres-{{ .version }}
+```
+
+## Support
+
+To speak with us, please leave a message on [our website](https://appscode.com/contact/).
+
+To join public discussions with the Stash community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. To sign up, use our [Slack inviter](https://slack.appscode.com/).
+
+To receive product annoucements, follow us on [Twitter](https://twitter.com/KubeStash).
+
+If you have found a bug with Stash or want to request new features, please [file an issue](https://github.com/stashed/project/issues/new).