Skip to content

Commit b24995e

Browse files
authored
Merge pull request #40 from ccremer/patch-1
Improve Docker usage documentation
2 parents a025f54 + 2aefc00 commit b24995e

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,15 @@ You can mount directory with charts under `/helm-docs` within container.
5151
Print generated documentation to stdout rather than modifying READMEs:
5252

5353
```bash
54-
docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest --dry-run
54+
docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest --dry-run
5555
```
5656

5757
Overwrite READMEs within mounted directory:
5858

5959
```bash
60-
docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest
60+
docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
6161
```
6262

63-
Notice: You may need to fix permissions to the created files.
64-
65-
6663
# Building from source
6764

6865
Notice that you need to have build chain toolkit for given platform and golang installed.

0 commit comments

Comments
 (0)