docs: improve README, bump release to 1.2.0v1.2.0

1 files changed, 130 insertions, 56 deletions

diff --git a/README.md b/README.md
index e1b0a49..43ece7a 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,44 @@ auto-typing and copying [password store](https://www.passwordstore.org/) data.
 If you'd rather use [fzf](https://github.com/junegunn/fzf) to copy your password-store data on both
 Xorg/X11 and Wayland, check out [pass-tessen](https://github.com/ayushnix/pass-tessen).
 
+### Why use `tessen`?
+
+- `tessen` can autotype or copy (or, do both at the same time!) your password store data including
+  all of your key-value pair data, besides the password
+
+  From what I've observed as of this commit, most scripts out there do not autotype and copy all of
+  your key-value pair data. They also do not offer choices about autotyping or copying data with the
+  same flexibility as `tessen` does.
+
+  Although [rofi-pass](https://github.com/carnager/rofi-pass) is a good alternative, it only works
+  on Xorg/X11. `tessen` is made to work on Wayland.
+
+- `tessen` tries to minimize the number of external binaries used in the script for speed and
+  efficiency. Besides the dependencies mentioned above, `tessen` doesn't use programs like `sed`,
+  `awk`, `tr`, `cut`, `find`, `sort`, `head`, `tail`, and other GNU coreutils, often used casually
+  when writing shell scripts
+
+- the code is linted using [shellcheck](https://github.com/koalaman/shellcheck) and formatted using
+  [shfmt](https://github.com/mvdan/sh)
+
+- focuses on minimalism and security (please let me know if you have any suggestions for
+  improvement)
+
 ## Installation
 
 ### Dependencies
 
+- [bash](https://www.gnu.org/software/bash/)
 - [pass](https://git.zx2c4.com/password-store/)
 - either one of [bemenu](https://github.com/Cloudef/bemenu), [rofi](https://github.com/lbonn/rofi),
   [wofi](https://hg.sr.ht/~scoopta/wofi)
 - [wtype](https://github.com/atx/wtype) (if you want to auto-type data)
 - [wl-clipboard](https://github.com/bugaevc/wl-clipboard) or
   [wl-clipboard-rs](https://github.com/YaLTeR/wl-clipboard-rs) (if you want to copy data)
-- [libnotify](https://gitlab.gnome.org/GNOME/libnotify) (to send notifications about copied data)
+- [libnotify](https://gitlab.gnome.org/GNOME/libnotify) (optional, to send notifications about
+  copied data)
+- [xdg-utils](https://www.freedesktop.org/wiki/Software/xdg-utils/) (optional, to open URLs)
+- [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional, to build the man page)
 
 ### Arch Linux
 
@@ -29,7 +56,7 @@ Xorg/X11 and Wayland, check out [pass-tessen](https://github.com/ayushnix/pass-t
 
 ```
 git clone https://github.com/ayushnix/tessen.git
-cd pass-tessen
+cd tessen
 sudo make install
 ```
 
@@ -39,9 +66,9 @@ which you probably should.
 ### Stable Release
 
 ```
-wget https://github.com/ayushnix/tessen/releases/download/v1.1.2/tessen-1.1.2.tar.gz
-tar xvzf tessen-1.1.2.tar.gz
-cd tessen-1.1.2
+wget https://github.com/ayushnix/tessen/releases/download/v1.2.0/tessen-1.2.0.tar.gz
+tar xvzf tessen-1.2.0.tar.gz
+cd tessen-1.2.0
 sudo make install
 ```
 
@@ -49,54 +76,117 @@ or, you know, `doas make install`.
 
 ## Usage
 
-`tessen` will automatically use the following environment variables if they're set or assume
-reasonable defaults.
+### Default Behavior
 
-- `PASSWORD_STORE_DIR` (the default location of your password store)
-- `PASSWORD_STORE_CLIP_TIME` (the amount of time for which password-store data stays on the
-  clipboard)
-- `TESSEN_BACKEND` (either one of `bemenu`, `rofi`, or `wofi` as the backend for `tessen`)
-- `TESSEN_ACTION` (choose to either `autotype`, `copy`, or do `both` at the same time)
+If a backend is not specified, tessen tries to find bemenu, rofi, and wofi in the order mentioned
+here. If rofi is used, it is expected that the [Wayland fork of rofi](https://github.com/lbonn/rofi)
+is being used. The [original rofi](https://github.com/davatorium/rofi) implementation made for X.Org
+is NOT supported.
 
-```
-tessen - autotype and copy data from password-store on wayland
+If an action is not specified, tessen shows an additional menu with the option to either autotype or
+copy data.
+
+The default value of the backend can also be set using the `TESSEN_BACKEND` environment variable.
+The default value of the action can be set using the `TESSEN_ACTION` environment variable.
+
+By default, tessen will keep a delay of 200 milliseconds when auto-typing data using wtype. This
+can be changed using the `TESSEN_DELAY` environment variable.
+
+### Additional Features
+
+**tessen** assumes that the data organization format is the same as mentioned on the [home page of
+password store](https://www.passwordstore.org/#organization).
 
-Usage: tessen [options]
+The first line should always have the password, and nothing else. All other lines may have key-value
+pairs like `key1: value1` or the `otpauth://` format URI. However, if a key called `password` is
+present, it will be ignored.
 
-  tessen                        use bemenu and either autotype OR copy data
-  tessen -b rofi                use rofi and either autotype OR copy data
-  tessen -b rofi -a autotype    use rofi and always autotype data
-  tessen -b rofi -a copy        use rofi and always copy data
-  tessen -b rofi -a both        use rofi and always autotype AND copy data
+If a key called `user` is present, it's value will be the default username instead of the basename
+of the selected file. This key can be modified using the `TESSEN_USERKEY` environment variable.
 
-  -b, --backend, --backend=     choose 'bemenu', 'rofi', or 'wofi' as backend (default: bemenu)
-  -a, --action, --action=       choose 'autotype', 'copy', or 'both'
-  -h, --help                    print this help menu
-  -v, --version                 print the version of tessen
+If a key called `url` is present, an option to open the value of the `url` key in the default web
+browser will be shown instead of auto type. This becomes the default behavior if `-a autotype`
+option is provided during the execution of tessen. The `url` key can be modified using the
+`TESSEN_URLKEY` environment variable.
+
+The `otpauth://` format is supported and used if pass-otp is installed.
+
+A value for the `autotype` key can be specified for custom auto-type behavior which overrides the
+default behavior of auto-typing the username and the password. For example,
+
+```
+$ pass example/john
+mypassword
+key1: value1
+key2: value2
+key3: value3
+key4: value4
+otpauth://totp/ACME%20Co:john@example.com?secret=HXDMVJECJJWSRB3HWIZR4IF...
+autotype: key1 :tab key2 :space key3 :enter key4 :delay :tab :otp pass :space path
 ```
 
-## Why should I use `tessen`?
+When the default auto-type option is used, an output similar to what is shown
+below will be auto-typed:
 
-- `tessen` can autotype or copy (or, do both at the same time!) your password store data including
-  all of your key-value pair data, besides the password
+```
+value1 <Tab> value2 <space> value3 <Return> value4 <delay for 1 sec> 384534 mypassword
+```
 
-  From what I've observed as of this commit, most scripts out there do not autotype and copy all of
-  your key-value pair data. They also do not offer choices about autotyping or copying data with the
-  same flexibility as `tessen` does.
+When specified as a value of the `autotype` key,
 
-  Although [rofi-pass](https://github.com/carnager/rofi-pass) is a good alternative, it only works
-  on Xorg/X11. `tessen` is made to work on Wayland.
+- `:tab` can be used to type the Tab key
+- `:space` can be used to type the Space key
+- `:enter` can be used to type the Enter key
+- `:delay` can be used to delay the type operation by 1 second
+- `:otp` can be used to generate and type the OTP, if `otpauth://` is present
+- `user`, or the value of `TESSEN_USERKEY`, can be used to type the username
+- `pass` or `password` can be used to type the password
+- `path`, `basename`, or `filename` can be used to type the name of the
+  selected file
+- any other key, such as `key1`, can be specified to print its value
 
-- `tessen` tries to minimize the number of external binaries used in the script for speed and
-  efficiency. Besides the dependencies mentioned above, `tessen` doesn't use programs like `sed`,
-  `awk`, `tr`, `cut`, `find`, `sort`, `head`, `tail`, and other GNU coreutils, often used casually
-  by people when writing shell scripts
+The value of the `autotype` key can be modified using the `TESSEN_AUTOKEY`
+environment variable.
 
-- the code is linted using [shellcheck](https://github.com/koalaman/shellcheck) and formatted using
-  [shfmt](https://github.com/mvdan/sh)
+### Environment Variables
 
-- focuses on minimalism and security (please let me know if you have any suggestions for
-  improvement)
+`PASSWORD_STORE_DIR`
+
+The default location of the password store directory.
+
+`PASSWORD_STORE_CLIP_TIME`
+
+The number of seconds after which the clipboard will be cleared.
+
+`TESSEN_BACKEND`
+
+The default dmenu like backend used by tessen. Choose either `bemenu`, the wayland fork of `rofi` by
+lbonn on GitHub, or `wofi`.
+
+`TESSEN_ACTION`
+
+The default action of tessen. Choose either `autotype`, `copy`, or `both`.
+
+`TESSEN_USERKEY`
+
+The key which specifies the username. By default, it is assumed to be `user`.
+
+`TESSEN_URLKEY`
+
+The key which specifies the URL. By default, it is assumed to be `url`.
+
+`TESSEN_AUTOKEY`
+
+The key which specifies the auto-type key. By default, it is assumed to be `autotype`.
+
+`TESSEN_DELAY`
+
+The delay in milliseconds when auto-typing is done using wtype. By default, it is 200
+milliseconds.
+
+`BROWSER`
+
+The default web browser to use to open URLs. If `xdg-open` is installed, this variable isn't needed.
 
 ## Caveats :warning:
 
@@ -112,22 +202,6 @@ Autotyping also does not work on Chromium based browsers on Wayland when using
 Firefox. This issue might've been fixed in
 [this](https://github.com/atx/wtype/commit/a81540b7d4920566ad271236ca88befc0002b462) commit.
 
-## Assumptions
-
-`tessen` works under several assumptions and tries to fail gracefully if they are not met. Please
-report any unexpected behavior.
-
-The data organization format is assumed to be the same as mentioned on this
-[page](https://www.passwordstore.org/). If valid key-value pairs aren't found, `tessen` will not
-show them.
-
-It is assumed that the name of the file itself is the username. For example, if you have a file
-`bank/mybankusername.gpg` in your password store, the assumed default username is `mybankusername`.
-However, if a valid username key value pair is present inside the file, `tessen` will show them for
-selection as well.
-
-If there are multiple non-unique keys, the value of the last key will be considered.
-
 ## What does `tessen` mean?
 
 [Here](https://en.wikipedia.org/wiki/Japanese_war_fan) you go.