Skip to content

Commit

Permalink
doc: Add more info on migrating to sub 2.x
Browse files Browse the repository at this point in the history
  • Loading branch information
juanibiapina committed May 22, 2024
1 parent 0a0c6ba commit cfc14d1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ directory structure:

The entry point in `bin/awesomecli` can then be:

```
```bash
#!/usr/bin/env bash

sub --name awesomecli --executable "${BASH_SOURCE[0]}" --relative ".." -- "$@"
Expand Down Expand Up @@ -158,6 +158,10 @@ to an XDG compliant cache directory that can be used for storing temporary files

## Migrating to Sub 2.x

### --bin was renamed to --executable

The `--bin` argument was renamed to `--executable` to better reflect its purpose.

### Usage comments

Sub 2.x introduces automatic validation and parsing of command line arguments
Expand Down

0 comments on commit cfc14d1

Please sign in to comment.