diff --git a/README.md b/README.md index a9768a3..d4f6b4a 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,12 @@ sudo cp mdcheckr /usr/local/bin ## Usage +``` +mdcheckr [ -h | --help ] [ -v | --version ] FILE .. +``` + +## Examples + Check a single markdown file: ``` @@ -46,6 +52,3 @@ Check all the markdown files in your Git repository: ```bash git ls-files | grep '\.md$' | tr '\n' '\0' | xargs -0 mdcheckr ``` - - - diff --git a/mdcheckr b/mdcheckr index 6362fae..f1698c1 100755 --- a/mdcheckr +++ b/mdcheckr @@ -227,7 +227,7 @@ function explain() { # Parse command-line optins... function show_usage() { cat << EOF -usage: mdcheckr [ -h | --help | -v | --version ] FILE .. +usage: mdcheckr [ -h | --help ] [ -v | --version ] FILE .. EOF } diff --git a/mdcheckr.1 b/mdcheckr.1 index 75f5aef..eb4c4ce 100644 --- a/mdcheckr.1 +++ b/mdcheckr.1 @@ -3,7 +3,7 @@ mdcheckr \- check markdown files for broken links and other errors. .SH SYNOPSIS .B mdcheckr -.IR file ... +[ \-h | --help ] [ -v | --version ] FILE .. .SH DESCRIPTION .B mdcheckr checks for broken internal and external links, as well as syntax issues with