aboutsummaryrefslogtreecommitdiff
path: root/_doc
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2022-08-25 19:34:30 +0700
committerShulhan <ms@kilabit.info>2022-08-25 19:34:38 +0700
commitdd5fb8eab675b150ce41c0571f1d5e02905d9e9a (patch)
treebf7ad4b68b5022d7597de702681414d6a21159f9 /_doc
parenta74359d0344293b7ff40b792f1f3ef0798f72c6b (diff)
downloadgotp-dd5fb8eab675b150ce41c0571f1d5e02905d9e9a.tar.xz
all: group all documents into directory _doc
Diffstat (limited to '_doc')
-rw-r--r--_doc/CHANGELOG.adoc63
l---------_doc/README.adoc1
-rw-r--r--_doc/index.adoc24
3 files changed, 88 insertions, 0 deletions
diff --git a/_doc/CHANGELOG.adoc b/_doc/CHANGELOG.adoc
new file mode 100644
index 0000000..f5389e5
--- /dev/null
+++ b/_doc/CHANGELOG.adoc
@@ -0,0 +1,63 @@
+// SPDX-FileCopyrightText: 2022 M. Shulhan <ms@kilabit.info>
+// SPDX-License-Identifier: GPL-3.0-or-later
+= gotp changelog
+Shulhan <ms@kilabit.info>
+:toc:
+:sectanchors:
+:sectlinks:
+
+
+[#v0_2_1]
+== gotp v0.2.1 (2022-08-07)
+
+[#v0_2_1_bug_fixes]
+=== Bug fixes
+
+all: fix base32 decoding on secret::
++
+--
+The base32 decoding should be without padding otherwise it will return
+an error (for some base32 string):
+
+ illegal base32 data at input byte XX
+--
+
+[#v0_2_1_chores]
+=== Chores
+
+_AUR: add package build for Arch Linux::
+This package build the gotp based on the latest tag and commit.
+
+go.mod: set minimum Go version to 1.18 and update all modules::
++
+--
+The 1.17 has been deprecated since the release of 1.19.
+
+This update affect the test cases on Cli.
+--
+
+[#v0_2_0]
+== gotp v0.2.0 (2022-03-14)
+
+Release gotp under GPL 3.0 or later.
+
+See https://kilabit.info/journal/2022/gpl/ for more information.
+
+
+[#v0_1_0]
+== gotp v0.1.0 (2022-02-08)
+
+The first release of gotp, a command line interface to manage and generate
+Time-based One Time Password (TOTP).
+
+Features,
+
+* Add a TOTP secret identified by unique LABEL.
+* Generate N number passwords using the secret identified by LABEL.
+* Import the TOTP configuration from other provider.
+ Currently, the only supported PROVIDER is Aegis and the supported file
+ is .txt.
+* List all labels stored in the configuration.
+* Remove LABEL from configuration.
+* Rename a LABEL into NEW-LABEL.
+* Encrypted secret using RSA based private key.
diff --git a/_doc/README.adoc b/_doc/README.adoc
new file mode 120000
index 0000000..59a23c4
--- /dev/null
+++ b/_doc/README.adoc
@@ -0,0 +1 @@
+../README \ No newline at end of file
diff --git a/_doc/index.adoc b/_doc/index.adoc
new file mode 100644
index 0000000..e8ed0c5
--- /dev/null
+++ b/_doc/index.adoc
@@ -0,0 +1,24 @@
+= gotp
+:toc:
+:sectanchors:
+:sectlinks:
+
+Welcome to gotp.
+
+Command line interface for Time-based One Time Password (TOTP).
+
+== Documentation
+
+link:CHANGELOG.html[CHANGELOG^]:: History of each release.
+
+link:README.html[README^]:: User manual page for gotp.
+
+== Development
+
+https://git.sr.ht/~shulhan/gotp[Repository^]:: Link to the source code.
+
+https://lists.sr.ht/~shulhan/gotp[Mailing list^]:: Link to development and
+discussion.
+
+https://todo.sr.ht/~shulhan/gotp[Issues^]:: Link to submit an issue,
+feedback, or request for new feature.