Skip to content
This repository was archived by the owner on Apr 22, 2020. It is now read-only.

Commit ab89cd4

Browse files
committed
Docs: Update main readme file
1 parent 6ca5b4b commit ab89cd4

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Simply Bash script to run dockerized commands.
66

77
1. Copy the `kd.sh` script to /usr/local/bin with `cp kd.sh /usr/local/bin/kd`
88
2. Make it executable with `chmod 777 /usr/local/bin/kd`
9-
3. Execute any Docker Command with `kd command-name [parameter]`
9+
3. Execute any Docker Command with `kd command [file_or_folder] [parameter] [parameter] [...]`
1010

1111
Command help:
1212

1313
```console
14-
Usage: kd command [file_or_folder] [parameter] [parameter] [...] [-v]
14+
Usage: kd command [file_or_folder] [parameter] [parameter] [...]
1515

1616
command: The Docker Command to execute, like 'hello-world' or 'git-changelog-generator'
1717

@@ -32,13 +32,17 @@ Examples:
3232

3333
Available commands:
3434

35-
* commit-validator
36-
* get-next-release-number
37-
* git-changelog-generator
38-
* hello-world
39-
* md2html
40-
41-
You can set KD_DEBUG=1 with 'export KD_DEBUG=1' to enable verbose debug info
35+
* commit-validator v0.1.1
36+
* get-next-release-number v1.0.2
37+
* git-changelog-generator v0.7.4
38+
* hello-world v0.2.1
39+
* md2html v1.1.1
40+
* mdline v0.1.0
41+
42+
Other options:
43+
- KD_DEBUG=1 to enable verbose debug info (export KD_DEBUG=1)
44+
- KD_EDGE=1 to use the latest release of the commands (export KD_EDGE=1)
45+
- KD_SENTINEL=1 to enable a 24h image cache sentinel (export KD_SENTINEL=1)
4246
```
4347

4448
## Available commands
@@ -47,4 +51,4 @@ You can set KD_DEBUG=1 with 'export KD_DEBUG=1' to enable verbose debug info
4751
- [Get Next Release Number](https://github.com/kairops/dc-get-next-release-number)
4852
- [Git Changelog Generator](https://github.com/kairops/dc-git-changelog-generator)
4953
- [Hello World!](https://github.com/kairops/dc-hello-world)
50-
- [Markdown to HTML file conversion](https://github.com/kairops/dc-md2html)
54+
- [Markdown to HTML file conversion](https://github.com/kairops/dc-md2html)

0 commit comments

Comments
 (0)