From 7080bdca00df3b8b334b3a42a2acaf67ce0b2880 Mon Sep 17 00:00:00 2001 From: Nicolas MASSE Date: Fri, 13 Nov 2020 17:50:17 +0100 Subject: [PATCH] update documentation --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e32254..dd2eb9c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ It checks all `a` and `img` tags in specified files. ## Installation ```sh -go get -u github.com/raviqqe/liche +git clone https://github.com/nmasse-itix/liche -b new-options +cd liche +go build -o liche +sudo cp liche /usr/local/bin/liche ``` * requires [Go Modules]("https://github.com/golang/go/wiki/Modules#how-to-use-modules") @@ -31,6 +34,7 @@ Options: -c, --concurrency Set max number of concurrent HTTP requests. [default: 512] -d, --document-root Set document root directory for absolute paths. -r, --recursive Search Markdown and HTML files recursively + -l, --local-only Validate only local links (file:// and bare links) -t, --timeout Set timeout for HTTP requests in seconds. Disabled by default. -x, --exclude Regex of links to exclude from checking. -v, --verbose Be verbose. @@ -51,7 +55,7 @@ Options: - File extensions: `.md`, `.html`, `.htm` - HTML tags: `a`, `img` - HTML attributes: `href`, `src` -- URL schemes: `http`, `https` +- URL schemes: `http`, `https`, `file` Also supports relative and absolute paths. (Absolute paths need `--document-root` option.)