summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore5
-rw-r--r--CHANGELOG.adoc26
-rw-r--r--Makefile4
3 files changed, 35 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 2ad3c05..0809472 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,7 @@
+# SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info>
+# SPDX-License-Identifier: GPL-3.0-only
+
+/CHANGELOG.html
+/README.html
/cover.html
/cover.out
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
new file mode 100644
index 0000000..bd85e35
--- /dev/null
+++ b/CHANGELOG.adoc
@@ -0,0 +1,26 @@
+// SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info>
+// SPDX-License-Identifier: GPL-3.0-only
+
+= jarink releases changelog
+:sectanchors:
+:toc:
+
+Change log of each release of the jarink software.
+
+[#jarink_v0_1_0]
+== jarink 0.1.0
+
+The first release of jarink provides the command "brokenlinks", to scan for
+broken links.
+The output of this command is list of page with its broken links in JSON
+format.
+
+This command accept the following options,
+
+`-verbose`::
+Print the page that being scanned to standard error.
+
+`-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.
diff --git a/Makefile b/Makefile
index 3699644..cc311e5 100644
--- a/Makefile
+++ b/Makefile
@@ -17,3 +17,7 @@ test:
CGO_ENABLED=1 go test -failfast -timeout=1m -race \
-coverprofile=$(COVER_OUT) ./...
go tool cover -html=$(COVER_OUT) -o $(COVER_HTML)
+
+.PHONY: doc.serve
+doc.serve:
+ ciigo serve .