Skip to content

Commit 70f33b5

Browse files
committed
update Readme
1 parent 3d7fd1a commit 70f33b5

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,19 @@ This is simple link status checker for text/markdown files.
2828
```
2929

3030
### Usage:
31+
```bash
32+
❯❯❯ linkstatus --help
33+
Usage: linkstatus [OPTIONS] [SOURCE]...
34+
35+
Check Link Status
36+
37+
Options:
38+
-r, --recursive Include all files from directories recursively
39+
-t, --timeout INTEGER Request timeout (default 4 second)
40+
--help Show this message and exit.
41+
```
42+
43+
![linkstatus](https://user-images.githubusercontent.com/11618054/67676030-aafb6400-f9a6-11e9-9d56-c27c21a9e0a8.png)
44+
45+
46+
**Note: Skip `link` check for any line by adding `noqa` (no quality assurance) as inline comment.**

0 commit comments

Comments
 (0)