From 4e227b9daa7256cd86ac844df3730faa45e5fe2f Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Fri, 24 Apr 2020 10:17:57 +0800 Subject: [PATCH] docs: add "Installation" section --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 023c499..7bbec2d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ It provides utilities that reflect best practices of Kubernetes chart developmen ## Contents +- [Installation](#installation) - [Resource Kinds](#resource-kinds) * [`common.configMap`](#commonconfigmap) * [`common.cronJob`](#commoncronjob) @@ -33,6 +34,25 @@ It provides utilities that reflect best practices of Kubernetes chart developmen +## Installation + +To use the library chart, `common` should be listed in `dependencies` field in your `Chart.yaml`: + +```yaml +dependencies: + - name: common + version: 0.2.0 + repository: https://hahow-helm-charts.storage.googleapis.com/ +``` + +Once you have defined dependencies, you should run the following command to download this chart into your `charts/` directory: + +```shell +$ helm dependency update +``` + + + ## Resource Kinds Kubernetes defines a variety of resource kinds, from `Secret` to `StatefulSet`. We define some of the most common kinds in a way that lets you easily work with them. @@ -1099,4 +1119,4 @@ serviceAccountName: release-name-mychart --- # if serviceAccount.create is false, the value will be "default" serviceAccountName: default -``` \ No newline at end of file +```