[2.0.19] - Updated README

Author: ConnerWill

docs/README.md

@@ -4,7 +4,7 @@
 
 # yayfzf
 
-> *AUR package **[fzf][fzf-url]** finder to search, install, remove, and manage packages using **[yay][yay-url]***
+> *Fullscreen interactive AUR / repo package manager using **[yay][yay-url]** and **[fzf][fzf-url]***
 
 [![Shellcheck][shellcheck-badge]][shellcheck-workflow]
 [![GitHub last commit][github-last-commit-badge]][github-commits]
@@ -25,8 +25,9 @@
 
 # Description
 
-AUR package [fzf][fzf-url] finder to search, install, remove, and manage packages using **[yay][yay-url]**
+`yayfzf` is a fullscreen interactive package manager for Arch Linux systems.
 
+It uses **[yay][yay-url]** for package operations and **[fzf][fzf-url]** for searching, selecting, installing, removing, and updating packages.
 
 <img width="100%" src="https://raw.githubusercontent.com/ConnerWill/Project-Template/main/assets/lines/rainbow.png">
 
@@ -44,6 +45,7 @@ AUR package [fzf][fzf-url] finder to search, install, remove, and manage package
     - [Git](#git)
   - [Usage](#usage)
     - [Command Line Options](#command-line-options)
+    - [Examples](#examples)
     - [Keybindings](#keybindings)
   - [Configuration](#configuration)
     - [Configuration Files](#configuration-files)
@@ -54,34 +56,42 @@ AUR package [fzf][fzf-url] finder to search, install, remove, and manage package
     - [Donate](#donate)
 <!--toc:end-->
 
-
 <img width="100%" src="https://raw.githubusercontent.com/ConnerWill/Project-Template/main/assets/lines/rainbow.png">
 
 # Screenshots
 
- <div align="center">
+<div align="center">
 
 | ![demo screenshot](/docs/images/demo-screenshot.png) | ![demo screenshot 2](/docs/images/demo-screenshot-2.png) |
 | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
 | ![demo screenshot 3](/docs/images/demo-screenshot-3.png) | ![demo screenshot 4](/docs/images/demo-screenshot-4.png) |
 
 </div>
 
-
 ## Features
 
-- Interactive menu for Arch Linux package manager
+- Interactive menu for Arch Linux package management
+- Package search using `yay`
+- Package selection using `fzf`
+- Install, remove, and update packages
 - Inline package information preview
-- Multi-select support via fzf
-- Toggleable preview window
-- Multiple built-in color themes
-- Configurable layout, borders, and keybindings
+- Multi-select support
+- Toggleable package preview window
+- Built-in color themes
+- Interactive theme selector
+- Configurable layout, border, prompt, preview window, and sort order
 - XDG-compliant configuration file support
+- Bash and Zsh completion support
 
 ## Requirements
 
+- `bash`
 - `yay`
 - `fzf`
+- `awk`
+- `sed`
+- `tr`
+- `tput`
 
 ## Installation
 
@@ -101,15 +111,15 @@ cd yayfzf
 chmod +x bin/yayfzf
 ```
 
-Optionally, move it to a directory in your PATH:
+Optionally, install the executable, documentation, man page, license, and shell completions:
 
 ```bash
-sudo install -Dm755 "bin/yayfzf" "/usr/local/bin/yayfzf"  # Main executable
-sudo install -Dm644 "docs/README.md" "/usr/share/doc/yayfzf/README.md"  # Documentation
-sudo install -Dm644 "docs/yayfzf.1" "/usr/share/man/man1/yayfzf.1"  # Man page
-sudo install -Dm644 "LICENSE" "/usr/share/licenses/yayfzf/LICENSE"  # License
-sudo install -Dm644 "completion/_yayfzf" "/usr/share/zsh/site-functions/_yayfzf"  # ZSH completion
-sudo install -Dm644 "completion/yayfzf_completion.sh" "/usr/share/bash-completion/completions/yayfzf"  # Bash completion
+sudo install -Dm755 "bin/yayfzf" "/usr/local/bin/yayfzf"
+sudo install -Dm644 "docs/README.md" "/usr/share/doc/yayfzf/README.md"
+sudo install -Dm644 "docs/yayfzf.1" "/usr/share/man/man1/yayfzf.1"
+sudo install -Dm644 "LICENSE" "/usr/share/licenses/yayfzf/LICENSE"
+sudo install -Dm644 "completion/_yayfzf" "/usr/share/zsh/site-functions/_yayfzf"
+sudo install -Dm644 "completion/yayfzf_completion.sh" "/usr/share/bash-completion/completions/yayfzf"
 ```
 
 ## Usage
@@ -120,23 +130,86 @@ Launch the interactive interface:
 yayfzf
 ```
 
+Start with an initial package search query:
+
+```bash
+yayfzf fzf
+```
+
 ### Command Line Options
 
 | Option | Description |
-| ------ |------------ |
-| `-t`, `--theme` | Set built-in theme |
+| ------ | ----------- |
+| `--sort-by [sort option]` | Set package search sort order |
+| `--no-preview` | Disable package preview window |
+| `-t`, `--theme [theme]` | Set built-in theme |
 | `-l`, `--list-themes` | Show list of built-in themes |
-| `-k`, `--keybindings` | Show keybindings and exit |
+| `--preview-themes` | Interactively preview and select a built-in theme |
 | `-i`, `--init-config` | Install example configuration file |
 | `-s`, `--show-config` | Show example configuration file content |
-| `--sort-order` | Set package sort order |
-| `--no-preview` | Disable preview window |
+| `-k`, `--keybindings` | Show keybindings and exit |
 | `-v`, `--verbose` | Show verbose output |
 | `-h` | Show short help |
 | `--help` | Show full help |
-| `--help-man` | Show manpage help |
+| `--help-man` | Show man page help |
 | `-V`, `--version` | Show version |
 
+### Examples
+
+Run `yayfzf` with no search query:
+
+```bash
+yayfzf
+```
+
+Search for `fzf`:
+
+```bash
+yayfzf fzf
+```
+
+Search packages sorted by votes:
+
+```bash
+yayfzf --sort-by votes
+```
+
+Start with the `dracula` theme:
+
+```bash
+yayfzf --theme dracula
+```
+
+Show all built-in themes:
+
+```bash
+yayfzf --list-themes
+```
+
+Open the interactive theme selector:
+
+```bash
+yayfzf --preview-themes
+```
+
+Start with the package preview window disabled:
+
+```bash
+yayfzf --no-preview
+```
+
+Install an example configuration file:
+
+```bash
+yayfzf --init-config
+```
+
+Show the short help menu:
+
+```bash
+yayfzf -h
+```
+
 ### Keybindings
 
 | Key | Action |
@@ -153,12 +226,12 @@ yayfzf
 | <kbd>CTRL</kbd>+<kbd>a</kbd> | Select all items |
 | <kbd>CTRL</kbd>+<kbd>d</kbd> | Deselect all items |
 | <kbd>CTRL</kbd>+<kbd>i</kbd> | Install selected packages |
-| <kbd>CTRL</kbd>+<kbd>r</kbd> | Uninstall package |
+| <kbd>CTRL</kbd>+<kbd>r</kbd> | Remove selected package |
 | <kbd>CTRL</kbd>+<kbd>u</kbd> | Update all packages |
-| <kbd>CTRL</kbd>+<kbd>l</kbd> | Clear search query |
-| <kbd>CTRL</kbd>+<kbd>Backspace</kbd> | Clear search query |
-| <kbd>CTRL</kbd>+<kbd>/</kbd> | Change layout |
-| <kbd>CTRL</kbd>+<kbd>v</kbd> | Toggle preview window |
+| <kbd>CTRL</kbd>+<kbd>l</kbd> | Clear query, screen, and selection |
+| <kbd>CTRL</kbd>+<kbd>Backspace</kbd> | Clear query |
+| <kbd>CTRL</kbd>+<kbd>/</kbd> | Cycle preview window position and size |
+| <kbd>CTRL</kbd>+<kbd>v</kbd> | Toggle package preview window |
 | <kbd>?</kbd> | Show keybindings |
 | <kbd>CTRL</kbd>+<kbd>c</kbd> | Exit yayfzf |
 | <kbd>CTRL</kbd>+<kbd>w</kbd> | Exit yayfzf |
@@ -168,26 +241,78 @@ yayfzf
 
 ### Configuration Files
 
-`yayfzf` looks for configuration files in this order (uses the first file found):
+`yayfzf` looks for configuration files in this order and uses the first file found:
 
 - `$XDG_CONFIG_HOME/yayfzf/yayfzf.conf`
 - `$HOME/.config/yayfzf/yayfzf.conf`
 - `$HOME/.yayfzf.conf`
 
+Install an example configuration file:
+
+```bash
+yayfzf --init-config
+```
+
+Show the current example configuration:
+
+```bash
+yayfzf --show-config
+```
+
 ### Configuration Options
 
-| Option | Description | Default | Options |
-| ------ | ----------- | ------- | ------- |
-| `THEME` | Color theme | `default` | `default`, `light`, `tokyo-night`, `neon`, `catppuccin-mocha`, `catppuccin-latte`, `dracula`, `gruvbox-dark`, `gruvbox-light`, `nord`, `solarized-dark`, `solarized-light`, `rose-pine`, `rose-pine-moon`, `rose-pine-dawn`, `onedark`, `kanagawa` |
-| `PREVIEW_WINDOW` | fzf preview window layout and size | `right:60%:wrap` | |
-| `ENABLE_PREVIEW` | Show preview window | `true` | `true`, `false` |
-| `SORT_BY` | Package sort order | `popularity` | `popularity`, `votes`, `last_updated` |
+| Option | Description | Default | Values |
+| ------ | ----------- | ------- | ------ |
+| `THEME` | Built-in color theme | `default` | `default`, `light`, `tokyo-night`, `neon`, `catppuccin-mocha`, `catppuccin-latte`, `dracula`, `gruvbox-dark`, `gruvbox-light`, `nord`, `solarized-dark`, `solarized-light`, `rose-pine`, `rose-pine-moon`, `rose-pine-dawn`, `onedark`, `kanagawa` |
+| `SORT_BY` | Package search sort order | `popularity` | `popularity`, `votes`, `last_updated` |
+| `PREVIEW_WINDOW` | fzf package preview window layout and size | `right:60%:wrap` | Any valid `fzf --preview-window` value |
 | `LAYOUT` | fzf layout | `reverse` | `default`, `reverse` |
-| `BORDER` | fzf border style | `rounded` | `default`, `rounded` |
-| `PROMPT` | Prompt string for fzf | `"yayfzf> "` | |
-| `VERBOSE` | Enable verbose logging | `false` | `true`, `false` |
-| `YAYFZF_PAGER` | Pager for help/config/keybindings | `${PAGER:-less}` | |
-| `CTRL_C_CLOSE` | Close yayfzf with Ctrl-C | `true` | `true`, `false` |
+| `BORDER` | fzf border style | `rounded` | Any valid `fzf --border` value |
+| `YAYFZF_PROMPT` | fzf prompt string | `yayfzf> ` | Any string |
+| `ENABLE_PREVIEW` | Enable package preview window | `true` | `true`, `false` |
+| `VERBOSE` | Enable verbose output | `false` | `true`, `false` |
+| `YAYFZF_PAGER` | Pager used for config/help output | `${PAGER:-less}` | `less`, `bat`, `more`, etc. |
+| `CTRL_C_CLOSE` | Exit when fzf returns an empty selection | `true` | `true`, `false` |
+| `NO_COLOR` | Disable ANSI color output | `false` | `true`, `false` |
+
+Example configuration:
+
+```bash
+# Theme: default, light, tokyo-night, neon, catppuccin-mocha, catppuccin-latte,
+# dracula, gruvbox-dark, gruvbox-light, nord, solarized-dark, solarized-light,
+# rose-pine, rose-pine-moon, rose-pine-dawn, onedark, kanagawa
+THEME="default"
+
+# Package sort order: popularity, votes, last_updated
+SORT_BY="popularity"
+
+# Preview window options for fzf
+PREVIEW_WINDOW="right:60%:wrap"
+
+# Layout: default, reverse
+LAYOUT="reverse"
+
+# Border style
+BORDER="rounded"
+
+# Prompt for fzf
+YAYFZF_PROMPT="yayfzf> "
+
+# Enable package preview window
+ENABLE_PREVIEW=true
+
+# Verbose output
+VERBOSE=false
+
+# Pager
+YAYFZF_PAGER="${PAGER:-less}"
+
+# Close yayfzf with Ctrl-C / empty fzf selection
+CTRL_C_CLOSE=true
+
+# Disable color output
+NO_COLOR=false
+```
 
 ## See Also
 
@@ -205,32 +330,32 @@ yayfzf
 
 <br>
 
-> Any contributions you make are **greatly appreciated**.
+> Any contributions you make are appreciated.
 
-> > If you want to contribute, please fork this repo and create a pull request.
+> If you want to contribute, please fork this repo and create a pull request.
 
-1. Fork the Project
-2. Create your Feature Branch
+1. Fork the project
+2. Create your feature branch
 
 ```console
 git checkout -b AmazingNewFeature
 ```
 
-3. Commit your Changes
+3. Commit your changes
 
 ```console
 git commit -m 'Description of the amazing feature you added'
 ```
 
-4. Push to the Branch
+4. Push to the branch
 
 ```console
 git push origin AmazingNewFeature
 ```
 
-5. Then open a pull request `:)`
+5. Open a pull request.
 
-> > If you experience any bugs/issues or have and suggestions, you can simply open an issue `:)`
+If you experience bugs or have suggestions, open an issue.
 
 </details>
 
@@ -242,7 +367,6 @@ git push origin AmazingNewFeature
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-
 <img width="100%" src="https://raw.githubusercontent.com/ConnerWill/Project-Template/main/assets/lines/rainbow.png">
 
 <!-- LINKS -->
@@ -273,8 +397,8 @@ git push origin AmazingNewFeature
 [wiki-installation-url]: https://github.com/ConnerWill/yayfzf/wiki/Installation
 [wiki-screenshots-url]: https://github.com/ConnerWill/yayfzf/wiki/Screenshots
 
-[fzf-url]: httaps://github.com/junegunn/fzf
+[fzf-url]: https://github.com/junegunn/fzf
 [yay-url]: https://github.com/Jguer/yay
 [yayfzf-url]: https://github.com/ConnerWill/yayfzf
-[rclonefzf-url]: https://github.com/ConnerWill/rclonefzf
 [yayfzf-source]: https://github.com/ConnerWill/yayfzf/blob/main/bin/yayfzf
+[rclonefzf-url]: https://github.com/ConnerWill/rclonefzf