From d0ca0577eab54147b0e36fdb00f833f6bf28352d Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Fri, 25 Dec 2020 01:30:57 -0800 Subject: [PATCH] Generate README.md using templates (#254) /cherry-pick Signed-off-by: Tamal Saha --- README.md | 4 ++-- hack/templates/readme.txt | 41 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 hack/templates/readme.txt diff --git a/README.md b/README.md index 6d0cc25c5..3022e2ace 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Install MySQL 8.0.3 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-mysql --name=stash-mysql-8.0.3 --version=8.0.3 +helm install stash-mysql-8.0.14 appscode/stash-mysql --version=8.0.14 --namespace=kube-system ``` To install catalog for all supported MySQL versions, please visit [here](https://github.com/stashed/catalog). @@ -25,7 +25,7 @@ To install catalog for all supported MySQL versions, please visit [here](https:/ Uninstall MySQL 8.0.3 backup or restore plugin for Stash as below. ```console -helm delete stash-mysql-8.0.3 +helm uninstall stash-mysql-8.0.14 --namespace=kube-system ``` ## Support diff --git a/hack/templates/readme.txt b/hack/templates/readme.txt new file mode 100644 index 000000000..13da7e547 --- /dev/null +++ b/hack/templates/readme.txt @@ -0,0 +1,41 @@ +[![Go Report Card](https://goreportcard.com/badge/stash.appscode.dev/mysql)](https://goreportcard.com/report/stash.appscode.dev/mysql) +![CI](https://github.com/stashed/mysql/workflows/CI/badge.svg) +[![Docker Pulls](https://img.shields.io/docker/pulls/stashed/stash-mysql.svg)](https://hub.docker.com/r/stashed/stash-mysql/) +[![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 -}} + +# MySQL + +MySQL backup and restore plugin for [Stash by AppsCode](https://stash.run). + +## Install + +Install MySQL {{ $v.Major }}.{{ $v.Minor }}.{{ $v.Patch }} backup or restore plugin for Stash as below. + +```console +helm repo add appscode https://charts.appscode.com/stable/ +helm repo update +helm install stash-mysql-{{ .version }} appscode/stash-mysql --version={{ .version }} --namespace=kube-system +``` + +To install catalog for all supported MySQL versions, please visit [here](https://github.com/stashed/catalog). + +## Uninstall + +Uninstall MySQL {{ $v.Major }}.{{ $v.Minor }}.{{ $v.Patch }} backup or restore plugin for Stash as below. + +```console +helm uninstall stash-mysql-{{ .version }} --namespace=kube-system +``` + +## 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).