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

Commit d2c94f9

Browse files
committed
Docs: Update main readme info
1 parent 3c6c9a1 commit d2c94f9

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,30 @@ Simply Bash script to run dockerized commands.
88
2. Make it executable with `chmod 777 /usr/local/bin/kd`
99
3. Execute any Docker Command with `kd command-name [parameter]`
1010

11+
Command help:
12+
13+
```console
14+
$ kd
15+
Usage: kd command [file_or_folder] [parameter] [parameter] [...]
16+
17+
command: The Docker Command to execute, like 'hello-world' or 'git-changelog-generator'
18+
19+
Options:
20+
[file_or_folder]: Optional file or folder to give to the container
21+
[parameter]: Optional parameters. Depends on the 'docker-command' that you are running
22+
23+
Examples:
24+
25+
kd hello-world
26+
kd git-changelog-generator .
27+
28+
You can also concatenate two or more Docker Commands through a pipe
29+
30+
Examples:
31+
32+
kd git-changelog-generator . | kd md2html > changelog.html
33+
```
34+
1135
## Available commands
1236

1337
- [Hello World!](https://github.com/kairops/dc-hello-world)

0 commit comments

Comments
 (0)