Browse Source

update documentation

new-options
Nicolas Massé 5 years ago
parent
commit
7080bdca00
  1. 8
      README.md

8
README.md

@ -13,7 +13,10 @@ It checks all `a` and `img` tags in specified files.
## Installation ## Installation
```sh ```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") * requires [Go Modules]("https://github.com/golang/go/wiki/Modules#how-to-use-modules")
@ -31,6 +34,7 @@ Options:
-c, --concurrency <num-requests> Set max number of concurrent HTTP requests. [default: 512] -c, --concurrency <num-requests> Set max number of concurrent HTTP requests. [default: 512]
-d, --document-root <directory> Set document root directory for absolute paths. -d, --document-root <directory> Set document root directory for absolute paths.
-r, --recursive Search Markdown and HTML files recursively -r, --recursive Search Markdown and HTML files recursively
-l, --local-only Validate only local links (file:// and bare links)
-t, --timeout <timeout> Set timeout for HTTP requests in seconds. Disabled by default. -t, --timeout <timeout> Set timeout for HTTP requests in seconds. Disabled by default.
-x, --exclude <regex> Regex of links to exclude from checking. -x, --exclude <regex> Regex of links to exclude from checking.
-v, --verbose Be verbose. -v, --verbose Be verbose.
@ -51,7 +55,7 @@ Options:
- File extensions: `.md`, `.html`, `.htm` - File extensions: `.md`, `.html`, `.htm`
- HTML tags: `a`, `img` - HTML tags: `a`, `img`
- HTML attributes: `href`, `src` - HTML attributes: `href`, `src`
- URL schemes: `http`, `https` - URL schemes: `http`, `https`, `file`
Also supports relative and absolute paths. Also supports relative and absolute paths.
(Absolute paths need `--document-root` option.) (Absolute paths need `--document-root` option.)

Loading…
Cancel
Save