Merge pull request #100 from hypnoglow/update-readme-changelog

Add documentation improvements

.github/CONTRIBUTING.md

@@ -15,7 +15,7 @@ Next, you may want to ensure if you have all prerequisites to build
 the plugin from source:
 
     cd ~/.helm/plugins/helm-s3
-    make deps build
+    make deps build-local
 
 If you see no messages - build was successful. Try to run some helm commands
 that involve the plugin, or jump straight into plugin development.

CHANGELOG.md

@@ -9,12 +9,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Helm v3 support. The plugin can detect Helm version and use the corresponding "mode" to operate properly. This means
+that Helm v2 is still supported, and will be until the sunset of v2 (approximately until the summer of 2020).
+[Refs: [#95](https://github.com/hypnoglow/helm-s3/pull/95) [#98](https://github.com/hypnoglow/helm-s3/pull/98)]
+
 - The plugin is now also distributed as Docker images. Images are pushed to Docker Hub tagged with plugin release 
 version and suffixed with Helm version. The image built from master branch is also available, note that it should be
 only used for playing and testing, it is **strongly discouraged** to use that image for production use cases. 
 Refer to https://hub.docker.com/r/hypnoglow/helm-s3 for details and all available tags.
 [Refs: [#79](https://github.com/hypnoglow/helm-s3/issues/79) [#88](https://github.com/hypnoglow/helm-s3/pull/88)]
 
+### Changed
+
+- Migrate to go modules & update Go to 1.12.
+[Refs: [#86](https://github.com/hypnoglow/helm-s3/pull/86)] [@moeryomenko](https://github.com/moeryomenko)
+
+- CI now runs tests on multiple Helm versions: v2.14, v2.15, v2.16, v3.0.
+[Refs: [#89](https://github.com/hypnoglow/helm-s3/pull/89) [#97](https://github.com/hypnoglow/helm-s3/pull/97)]
+
+- Huge rework on internal Helm integration code to provide support for both Helm v2 and v3.
+[Refs: [#95](https://github.com/hypnoglow/helm-s3/pull/95) [#98](https://github.com/hypnoglow/helm-s3/pull/98)]
+
+- Bumped almost all dependencies to more actual versions. Helm SDK now includes both v2.16.1 and v3.0.0.
+[Refs: [#74](https://github.com/hypnoglow/helm-s3/pull/74) [#69](https://github.com/hypnoglow/helm-s3/issues/69) [#87](https://github.com/hypnoglow/helm-s3/pull/87)] [@willejs](https://github.com/willejs)
+
 ### Fixed
 
 - Fixed incorrect s3 url when "proxy" runs on uninitialized repository.

README.md

@@ -95,6 +95,9 @@ for a CI that builds and pushes charts to your repository.
 
 ## Usage
 
+*Note: some Helm CLI commands in v3 are incompatible with v2. Example commands below are provided for v2. For commands 
+different in v3 there is a tip 💡 below each example.*
+
 For now let's omit the process of uploading repository index and charts to s3 and assume
 you already have your repository `index.yaml` file on s3 under path `s3://bucket-name/charts/index.yaml`
 and a chart archive `epicservice-0.5.1.tgz` under path `s3://bucket-name/charts/epicservice-0.5.1.tgz`.
@@ -110,11 +113,21 @@ Try:
     NAME                       	VERSION	  DESCRIPTION
     coolcharts/epicservice	    0.5.1     A Helm chart.
 
+💡 *For Helm v3, use `helm search repo coolcharts`*
+
+To install the chart:
+
     $ helm install coolchart/epicservice --version "0.5.1"
 
 Fetching also works:
 
+    $ helm fetch coolchart/epicservice --version "0.5.1"
+
+Alternatively:
+
     $ helm fetch s3://bucket-name/charts/epicservice-0.5.1.tgz
+
+💡 *For Helm v3, use `helm pull coolchart/epicservice --version "0.5.1"`*
 
 ### Init
 
@@ -144,6 +157,8 @@ Your pushed chart is available:
     NAME                    VERSION	 DESCRIPTION
     mynewrepo/epicservice   0.7.2    A Helm chart.
 
+💡 *For Helm v3, use `helm search repo mynewrepo`*
+
 Note that the plugin denies push when the chart with the same version already exists
 in the repository. This behavior is intentional. It is useful, for example, in
 CI automated pushing: if someone forgets to bump chart version - the chart would
@@ -171,6 +186,8 @@ The chart is deleted from the repo:
     $ helm search mynewrepo/epicservice
     No results found
 
+💡 *For Helm v3, use `helm search repo mynewrepo/epicservice`*
+
 ### Reindex
 
 If your repository somehow became inconsistent or broken, you can use reindex to recreate

plugin.yaml

@@ -1,8 +1,8 @@
 name: "s3"
 version: "0.8.0"
-usage: "The plugin allows to use s3 protocol to upload, fetch charts and to work with repositories."
+usage: "Manage chart repositories on Amazon S3"
 description: |-
-  Provides AWS S3 protocol support.
+  The plugin allows to use s3 protocol to upload, fetch charts and to work with repositories.
   https://github.com/hypnoglow/helm-s3
 command: "$HELM_PLUGIN_DIR/bin/helms3"
 downloaders: