Skip to content

Commit e77be2a

Browse files
committed
update examples/README
1 parent 75750b3 commit e77be2a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

examples/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Each of these examples demonstrates one aspect or feature of bashly.
55
## Basic use
66

77
- [minimal](minimal#readme) - the most basic "hello world" example
8-
- [commands](commands#readme) - a script with sub-commands
9-
- [commands-nested](commands-nested#readme) - a script with nested sub-commands
8+
- [commands](commands#readme) - a script with subcommands
9+
- [commands-nested](commands-nested#readme) - a script with nested subcommands
1010

1111
## Basic features
1212

@@ -17,6 +17,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
1717
- [dependencies](dependencies#readme) - halting script execution unless certain dependencies are installed
1818
- [dependencies-alt](dependencies-alt#readme) - halting script execution unless one of the required dependencies is installed
1919
- [environment-variables](environment-variables#readme) - halting script execution unless certain environment variables are set
20+
- [variables](variables#readme) - defining bash variables
2021
- [default-values](default-values#readme) - arguments and flags with default values
2122
- [minus-v](minus-v#readme) - using `-v` and `-h` in your script
2223
- [multiline](multiline#readme) - help messages with multiple lines
@@ -38,14 +39,14 @@ Each of these examples demonstrates one aspect or feature of bashly.
3839
- [private-reveal](private-reveal#readme) - allowing users to reveal private commands, flags or environment variables
3940
- [stdin](stdin#readme) - reading input from stdin
4041
- [filters](filters#readme) - preventing commands from running unless custom conditions are met
41-
- [commands-expose](commands-expose#readme) - showing sub-commands in the parent's help
42+
- [commands-expose](commands-expose#readme) - showing subcommands in the parent's help
4243
- [key-value-pairs](key-value-pairs#readme) - parsing key=value arguments and flags
4344
- [command-examples-on-error](command-examples-on-error#readme) - showing examples on error
4445

4546
## Customization
4647

4748
- [colors-usage](colors-usage#readme) - adding colors to the usage text
48-
- [command-groups](command-groups#readme) - grouping sub-commands in logical sections
49+
- [command-groups](command-groups#readme) - grouping subcommands in logical sections
4950
- [custom-strings](custom-strings#readme) - configuring the script's error and usage texts
5051
- [custom-includes](custom-includes#readme) - adding and organizing your custom functions
5152
- [custom-script-header](custom-script-header#readme) - configuring a different script header
@@ -68,7 +69,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
6869
## Real-world-like examples
6970

7071
- [docker-like](docker-like#readme) - a sample script with deep commands (like `docker container run`)
71-
- [git-like](git-like#readme) - a sample script with sub-commands similar to git
72+
- [git-like](git-like#readme) - a sample script with subcommands similar to git
7273

7374
## Documentation generation
7475

0 commit comments

Comments
 (0)