better README. Close #6

README.md

@@ -5,18 +5,90 @@ CLI tool that helps verify current status of URIs in text files
 # Installing
 
 ```
-go get github.com/npxbr/verify-links/cmd/vl
+go instal github.com/npxbr/verify-links/cmd/vl@latest
 ```
 
 # Usage
 
+## Common usage
+
+```
+$ vl FILE
+```
+
+## Flags
+
+```
+-a (Skip status codes list)
+```
+
+Example:
+
+```sh
+$ vl README.md -a 500,404
+```
+
+All `500` and `404` errors will be ignored and not considered as errors
+
+```
+-t (timeout for each request)
+```
+
+Example:
+
+```sh
+$ vl README.md -t 30s
+```
+
+Each request that takes more than 30s will be considered as an error. The values
+accepted must be under the durations values. Some examples
+[here](https://golang.org/pkg/time/#ParseDuration)
+
+```
+-w Whitelist URIs
+```
+
+Example:
+
+```sh
+$ vl README.md -w server1.com,server2.com
 ```
-  -a string (Skip status code list)
-        -a 500,400
-  -s int (Concurrency size)
-        -s 50 (default 50)
-  -t duration (max timeout for each request)
-        -t 10s or -t 1h (default 5s)
-  -w string (whitelist URI list)
-        -w server1.com,server2.com
+
+Adds a list of whitelisted links that shouldn't be verified. Links must be exactly
+passed as they are in the text file
+
+# Screenshots
+
+## Terminal output
+
+_terminal colors are only working in linux_
+
+![](https://i.postimg.cc/xqD8YDfz/Screenshot-from-2021-03-18-17-42-31.png)
+
+## Github Action
+
+![](https://i.postimg.cc/VNpd4bxg/Screenshot-from-2021-03-18-18-29-21.png)
+
+# Running in a Github Action
+
+An example of a workflow file:
+
+```yaml
+---
+name: CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v2.1.3
+        id: go
+        with:
+          go-version: '^1.16.1'
+
+      - uses: actions/checkout@v2.3.4
+
+      - run: go get github.com/npxbr/verify-links/cmd/vl
+      - run: vl README.md
 ```