Skip to content

Commit 031cb65

Browse files
committed
add install instructions
1 parent 6572cdd commit 031cb65

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ clean:
3939
.PHONY: release
4040
release:
4141
eval "sed -i 's/version:.*/version: \"$$version\"/g' plugin.yaml"
42-
git add "plugin.yaml"
42+
eval "sed -i 's/version=.*/version=$$version/g' README.md"
43+
git add plugin.yaml README.md
4344
git commit -m "releases $(version)"
4445
git tag -a $(version) -m "release $(version)"
4546
git push origin

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
11
# helm-doc
22
a helm plugin for documentation generation
33

4-
[![Build Status](https://travis-ci.com/random-dwi/helm-doc.svg?branch=master)](https://travis-ci.com/random-dwi/helm-doc)
4+
[![Build Status](https://travis-ci.com/random-dwi/helm-doc.svg?branch=master)](https://travis-ci.com/random-dwi/helm-doc)
5+
6+
## installation
7+
8+
choose the variant needed and install with the following:
9+
10+
```bash
11+
version=0.1.0
12+
#variant=Linux_x86_64
13+
#variant=Linux_i386
14+
#variant=Darwin_x86_64
15+
#variant=Darwin_i386
16+
helm plugin install https://github.com/random-dwi/helm-doc/releases/download/${version}/helm-doc_${version}_${variant}.tar.gz
17+
```

0 commit comments

Comments
 (0)