Skip to content

Commit 5a99c5d

Browse files
committed
Update Read Me Options section
To align it with recent and older changes in `--help` output.
1 parent cbf69a5 commit 5a99c5d

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,18 @@ Or from vim, to insert the output into the commit message, type `:r!composer-loc
3838

3939
### Options
4040

41-
- `--path, -p`: Base to with which to prefix paths. Default "./"
42-
- `--from`: The file^, git ref, or git ref with filename to compare from (HEAD:composer.lock)
41+
- `-h, --help`: Print this message
42+
- `-p, --path`: Base to with which to prefix paths. Default "./"
43+
E.g. `-p app` would look for HEAD:app/composer.lock and app/composer.lock
44+
- `--from`: The file^, git ref, or git ref with filename to compare from (git: HEAD:composer.lock, svn: composer.lock@BASE)
4345
- `--to`: The file^, git ref, or git ref with filename to compare to (composer.lock)
44-
- `--md`: Markdown table output
45-
- `--json`: json output
46-
- `--pretty`: pretty output when combined with `--json` (>=5.4 only)
46+
- `--json`: Format output as JSON
47+
- `--pretty`: Pretty print JSON output (PHP >= 5.4.0)
48+
- `--md`: Use markdown instead of plain text
4749
- `--no-links`: Don't include Compare links in plain text or any links in markdown
4850
- `--only-prod`: Only include changes from `packages`
4951
- `--only-dev`: Only include changes from `packages-dev`
50-
- `--vcs`: Force vcs (git, svn, ...). Default auto-detect from path
52+
- `--vcs`: Force vcs (git, svn, ...). Default: attempt to auto-detect
5153

5254
^ File includes anything available as a [protocol stream wrapper](http://php.net/manual/en/wrappers.php) such as URLs.
5355

0 commit comments

Comments
 (0)