Skip to content

Commit

Permalink
[cherry-pick] Generate README.md using templates (#254) (#256)
Browse files Browse the repository at this point in the history
/cherry-pick

Signed-off-by: Tamal Saha <tamal@appscode.com>

Co-authored-by: Tamal Saha <tamal@appscode.com>
  • Loading branch information
1gtm and tamalsaha authored Dec 25, 2020
1 parent e96a04e commit 5979f66
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Install MySQL 8.0.14 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.14 --version=8.0.14
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).
Expand All @@ -25,7 +25,7 @@ To install catalog for all supported MySQL versions, please visit [here](https:/
Uninstall MySQL 8.0.14 backup or restore plugin for Stash as below.

```console
helm delete stash-mysql-8.0.14
helm uninstall stash-mysql-8.0.14 --namespace=kube-system
```

## Support
Expand Down
41 changes: 41 additions & 0 deletions hack/templates/readme.txt
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 5979f66

Please sign in to comment.