diff --git a/README.md b/README.md index b7e2adfb5..5a246ce6c 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,30 @@ # CLI `kubectl` plugin for [Stash by AppsCode](https://appscode.com/products/stash). +## Installation + +To install Stash, please follow the guide [here](https://stash.run/docs/latest/setup/). + +## Using Stash + +Want to learn how to use Stash? Please start [here](https://stash.run/docs/latest/). + +## Contribution guidelines + +Want to help improve Stash? Please start [here](https://stash.run/docs/latest/welcome/contributing). + --- -**Stash binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`. +**Stash binaries collect anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`. --- ## Support -We use Slack for public discussions. To chit chat with us or the rest of the 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/). -If you have found a bug with Stash or want to request for new features, please [file an issue](https://github.com/stashed/project/issues/new). +To speak with us, please leave a message on [our website](https://appscode.com/contact/). + +To join public discussions with the KubeDB 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).