From 3aaf1dd2a070f04c81c58681b32186abb3a956b9 Mon Sep 17 00:00:00 2001
From: Shulhan <ms@kilabit.info>
Date: Thu, 12 Feb 2026 08:59:22 +0700
Subject: all: update the README

Rewording some paragraphs, formatting on code, and add INSTALL
section.
---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 49 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 4a9f50c..2e104db 100644
--- a/README.md
+++ b/README.md
@@ -22,12 +22,13 @@ Available commands,
 
     [OPTIONS] brokenlinks <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 `brokenlinks` command scan for broken links on the web server pointed by
+URL.
+Links will be scanned on the anchor `href` attribute ("&lt;a href=...&gt;")
+or on the image `src` attribute ("&lt;img src=...&gt;").
 
-The URL can be start from base or from sub path.
-Scanning from path only report brokenlinks on that path and their
+The URL can be set to domain or with path.
+Scanning with path will report broken links on that path and their
 sub paths.
 
 Once finished it will print the page and list of broken links in
@@ -35,14 +36,13 @@ JSON format to standard output,
 
 ```
 {
-	"$PAGE": [{
-		"url": <string>,
-		"error": <string>,
-		"status_code": <integer>
-	},
-	...
-	],
-	...
+  "$PAGE": [{
+    "value": <string>,
+    "url": <string>,
+    "error": <string>,
+    "status_code": <integer>
+  },{
+  ...
 }
 ```
 
@@ -52,7 +52,7 @@ This command accept the following options,
 List of HTTP status code that will be ignored during scan.
 
 `-insecure`:
-Do not report as error on server with invalid certificates.
+Ignore website with invalid certificates.
 
 `-past-result=<path to JSON file>`:
 Scan only the pages reported by result from past scan based
@@ -87,14 +87,46 @@ Ignore HTTP status code 403 and 418,
 $ jarink -ignore-status=403,418 brokenlinks https://web.tld/page2
 ```
 
-## NOTES
+## INSTALL
 
-Project page - https://kilabit.info/project/jarink/
+Requirements,
 
-Source code - https://git.sr.ht/~shulhan/jarink
+- [Go compiler](https://go.dev/dl)
+- [git SCM](https://git-scm.org)
+- make program
+
+Manual installation using Go,
+
+```
+$ go install git.sr.ht/~shulhan/jarink/cmd/jarink
+$
+```
+
+This will install the `jarink` program into `$GOBIN` directory.
+Run `go env` to find out where `$GOBIN` is located.
+
+Building from source code,
+
+```
+$ git clone https://git.sr.ht/~shulhan/jarink
+$ cd jarink
+$ make build
+$
+```
+
+This will build the `jarink` program into the current directory.
+
+## SEE ALSO
+
+Project page - <https://kilabit.info/project/jarink/>
+
+Changelog - <https://kilabit.info/project/jarink/CHANGELOG.html>
+
+Source code - <https://git.sr.ht/~shulhan/jarink>
 
 ## LICENSE
 
 This software is licensed under GPL 3.0.
 See the LICENSE file for more information.
+
 Copyright 2025 M. Shulhan &lt;ms@kilabit.info&gt;.
-- 
cgit v1.3