all: use markdown for formatting README

This is so the README can be rendered in pkg.go.dev and in git.sr.ht.

While at it, group documentation files under _doc/ directory.

7 files changed, 35 insertions, 58 deletions

diff --git a/.gitignore b/.gitignore
index 0809472..b0e3e11 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,5 @@
 # SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info>
 # SPDX-License-Identifier: GPL-3.0-only
 
-/CHANGELOG.html
-/README.html
-/cover.html
+*.html
 /cover.out
diff --git a/README.adoc b/README.adoc
deleted file mode 120000
index 100b938..0000000
--- a/README.adoc
+++ /dev/null
@@ -1 +0,0 @@
-README
\ No newline at end of file
diff --git a/README.adoc.license b/README.adoc.license
deleted file mode 100644
index 22616a9..0000000
--- a/README.adoc.license
+++ /dev/null
@@ -1,2 +0,0 @@
-SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info>
-SPDX-License-Identifier: GPL-3.0-only
diff --git a/README b/README.md
index 02debe8..ca63317 100644
--- a/README
+++ b/README.md
@@ -1,25 +1,26 @@
-= Jarink
-:sectanchors:
-:toc:
+<!-- SPDX-License-Identifier: GPL-3.0-only -->
+<!-- SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info> -->
+
+# Jarink
 
 Jarink is a program to help web administrator and developers to inspect
 and maintains their website.
 
-== Synopsis
+## SYNOPSIS
 
-        jarink [OPTIONS] <COMMAND> <args...>
+    jarink [OPTIONS] <COMMAND> <args...>
 
 Available commands,
 
-        brokenlinks - scan the website for broken links (page and images).
-        help        - print the usage of the command.
-        version     - print the version of program.
+    brokenlinks - scan the website for broken links (page and images).
+    help        - print the usage of the command.
+    version     - print the version of program.
 
-== Usage
+## USAGE
 
-=== brokenlinks command
+### The brokenlinks command
 
-	[OPTIONS] brokenlinks <URL>
+    [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
@@ -32,7 +33,7 @@ sub paths.
 Once finished it will print the page and list of broken links in
 JSON format to standard output,
 
-----
+```
 {
 	"$PAGE": [{
 		"link": <string>,
@@ -43,26 +44,25 @@ JSON format to standard output,
 	],
 	...
 }
-----
+```
 
 This command accept the following options,
 
-`-ignore-status=<comma separated HTTP status code>`::
+`-ignore-status=<comma separated HTTP status code>`:
 List of HTTP status code that will be ignored during scan.
 
-`-insecure`::
+`-insecure`:
 Do not report as error on server with invalid certificates.
 
-`-past-result=<path to JSON file>`::
+`-past-result=<path to JSON file>`:
 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.
 
-`-verbose`::
+`-verbose`:
 Print the page that being scanned to standard error.
 
-
-== Examples
+## EXAMPLES
 
 Given a website that have the following pages,
 
@@ -72,52 +72,32 @@ Given a website that have the following pages,
 - web.tld/page2
 - web.tld/page2/sub1
 
-
 The following command will scan all of the pages in the website web.tld.
 
-----
+```
 $ jarink brokenlinks https://web.tld
-----
+```
 
 Invoking brokenlinks on path "/page2" only scan "/page2" and "/page2/sub1".
 
-----
+```
 $ jarink brokenlinks https://web.tld/page2
-----
+```
 
 Ignore HTTP status code 403 and 418,
 
-----
+```
 $ jarink -ignore-status=403,418 brokenlinks https://web.tld/page2
-----
+```
 
+## NOTES
 
-== Notes
-
-jarink version 0.1.0.
+Project page - https://kilabit.info/project/jarink/
 
 Source code - https://git.sr.ht/~shulhan/jarink
 
-
-== License
+## LICENSE
 
 This software is licensed under GPL 3.0.
-
-Copyright 2025 Shulhan <ms@kilabit.info>
-
-This program is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the Free
-Software Foundation, either version 3 of the License, or (at your option)
-any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.
-See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with
-this program.
-If not, see <http://www.gnu.org/licenses/>.
-
-// SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info>
-// SPDX-License-Identifier: GPL-3.0-only
+See the LICENSE file for more information.
+Copyright 2025 M. Shulhan &lt;ms@kilabit.info&gt;.
diff --git a/_doc/CHANGELOG.adoc b/_doc/CHANGELOG.adoc
new file mode 120000
index 0000000..e59a806
--- /dev/null
+++ b/_doc/CHANGELOG.adoc
@@ -0,0 +1 @@
+../CHANGELOG.adoc
\ No newline at end of file
diff --git a/_doc/index.md b/_doc/index.md
new file mode 120000
index 0000000..32d46ee
--- /dev/null
+++ b/_doc/index.md
@@ -0,0 +1 @@
+../README.md
\ No newline at end of file
diff --git a/jarink.go b/jarink.go
index 9da2f07..643a514 100644
--- a/jarink.go
+++ b/jarink.go
@@ -8,9 +8,9 @@ import (
 )
 
 // Version of jarink program and module.
-var Version = `0.2.1`
+var Version = `0.2.2`
 
 // GoEmbedReadme embed the README for showing the usage of program.
 //
-//go:embed README
+//go:embed README.md
 var GoEmbedReadme string