From e0b754ff6075bcaf56deb22aa9bbdd936c7d8792 Mon Sep 17 00:00:00 2001 From: Yota Toyama Date: Sat, 18 Nov 2017 22:12:12 +0900 Subject: [PATCH] Improve usage description --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 24fb5e9..40b99e6 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,30 @@ go get -u github.com/raviqqe/liche ## Usage ```sh -liche file.md -liche file1.md file2.md +> liche --help +Link checker for Markdown and HTML + +Usage: + liche [-c ] [-t ] [-v] ... + +Options: + -c, --concurrency Set max number of concurrent HTTP requests [default: 32] + -t, --timeout Set timeout for HTTP requests in seconds + -v, --verbose Be verbose +``` + +### Markdown + +```sh +> liche file.md +> liche file1.md file2.md +``` + +### HTML + +```sh +> liche file.html +> liche file1.html file2.html ``` ## Supported properties