all: add option to scan pass result

The brokenlinks command now have option "-past-result" that accept
path to JSON file from the past result.
If its set, the program will only scan the pages with broken links
inside that report.

1 files changed, 31 insertions, 50 deletions

diff --git a/README b/README
index 3335049..796cbd7 100644
--- a/README
+++ b/README
@@ -7,40 +7,22 @@ and maintains their website.
 
         jarink [OPTIONS] <COMMAND> <args...>
 
-Available commands,
+Available command,
 
         brokenlinks - scan the website for broken links (page and images).
-        help - print the usage of the command.
+        help        - print the usage of the command.
 
 == Usage
 
-[OPTIONS] brokenlinks URL
+[OPTIONS] brokenlinks <URL>
 
-        Start scanning for broken links on the web server pointed by URL.
+        Scan for broken links on the web server pointed by URL.
         Links will be scanned on anchor href attribute ("<a href=...>") or
         on the image src attribute ("<img src=...").
 
         The URL can be start from base or from sub path.
         Scanning from path only report brokenlinks on that path and their
         sub paths.
-        For example, given a website that have the following pages,
-
-                - web.tld (base)
-                - web.tld/page1
-                - web.tld/page1/sub1
-                - web.tld/page2
-                - web.tld/page2/sub1
-
-        Invoking brokenlinks with
-
-                $ jarink brokenlinks https://web.tld
-
-        will scan all of the pages, but invoking brokenlinks on path
-        "/page2"
-
-                $ jarink brokenlinks https://web.tld/page2
-
-        only scan "/page2" and "/page2/sub1".
 
         Once finished it will print the page and list of broken links in
         JSON format to standard output,
@@ -58,36 +40,35 @@ Available commands,
 
         This command accept the following options,
 
-                -verbose : print the page that being scanned to standard
-                           error.
+        -verbose
+
+                Print the page that being scanned to standard error.
+
+        -past-result=<path to JSON file>
 
-        Example,
+                Scan only the pages reported by result from past scan based
+                on the content in JSON file. This minimize the time to
+                re-scan the pages once we have fixed the URLs.
+
+        For example, given a website that have the following pages,
+
+                - web.tld (base)
+                - web.tld/page1
+                - web.tld/page1/sub1
+                - web.tld/page2
+                - web.tld/page2/sub1
+
+        Invoking brokenlinks with
+
+                $ jarink brokenlinks https://web.tld
+
+        will scan all of the pages, but invoking brokenlinks on path
+        "/page2"
+
+                $ jarink brokenlinks https://web.tld/page2
+
+        only scan "/page2" and "/page2/sub1".
 
-        $ jarink brokenlinks https://kilabit.info
-        {
-          "https://kilabit.info/some/page": [
-            {
-              "link": "https://kilabit.info/some/page/image.png",
-              "code": 404
-            },
-            {
-              "link": "https://external.com/link",
-              "error": "Internal server error",
-              "code": 500
-            }
-          ],
-          "https://kilabit.info/another/page": [
-            {
-              "link": "https://kilabit.info/another/page/image.png",
-              "code": 404
-            },
-            {
-              "link": "https://external.org/link",
-              "error": "Internal server error",
-              "code": 500
-            }
-          ]
-        }
 
 == Notes