Skip to content

Commit c31427b

Browse files
committed
example readme updates
1 parent bb20e6c commit c31427b

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

examples/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
1111
## Basic features
1212

1313
- [command-default](command-default#readme) - configuring a default command
14+
- [command-default-force](command-default-force#readme) - configuring a default command that runs instead of showing the usage text
1415
- [command-aliases](command-aliases#readme) - allowing a command to be called with multiple names
1516
- [command-examples](command-examples#readme) - configuring command examples
1617
- [dependencies](dependencies#readme) - halting script execution unless certain dependencies are installed

examples/command-default-force/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Default Forced Command Example
22

33
Demonstrates how to set a command as the default command, that also rune when
4-
the it is executed without arguments, instead of showing the standard usage
5-
text.
4+
it is executed without arguments, instead of showing the standard usage text.
65

76
This example was generated with:
87

@@ -86,6 +85,23 @@ args: none
8685
args: none
8786
8887
88+
```
89+
90+
### `$ ./tester all -h`
91+
92+
```shell
93+
tester all - Run all tests
94+
95+
Usage:
96+
tester all
97+
tester all --help | -h
98+
99+
Options:
100+
--help, -h
101+
Show this help
102+
103+
104+
89105
```
90106

91107
### `$ ./tester only one`

0 commit comments

Comments
 (0)