cleanup: update README

Author: kbdharun

README.md

@@ -9,7 +9,12 @@ Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr).
 
 ## Installation
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/tldr-python-client.svg)](https://repology.org/project/python-tldr-client/versions)
+<details open>
+  <summary>Check Repology Packaging Status!</summary>
+  <a href="https://repology.org/project/tldr-python-client/versions">
+      <img src="https://repology.org/badge/vertical-allrepos/tldr-python-client.svg" alt="Packaging status">
+  </a>
+</details>
 
 ### from PyPI
 
@@ -38,27 +43,31 @@ sudo snap install tldr
 ## Usage
 
 ```
-usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command
+usage: tldr command [options]
 
 Python command line client for tldr
 
 positional arguments:
   command               command to lookup
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -v, --version         show program's version number and exit
-  -u, --update_cache    Update the local cache of pages and exit
+  --search "KEYWORDS"   Search for a specific command from a query
+  -u, --update, --update_cache
+                        Update the local cache of pages and exit
   -p PLATFORM, --platform PLATFORM
-                        Override the operating system [linux, osx, sunos,
-                        windows, common]
+                        Override the operating system [linux, osx, sunos, windows, common]
+  -l, --list            List all available commands for operating system
   -s SOURCE, --source SOURCE
                         Override the default page source
   -c, --color           Override color stripping
   -r, --render          Render local markdown files
-  -l, --list            List all available commands for operating system    
   -L LANGUAGE, --language LANGUAGE
                         Override the default language
+  -m, --markdown        Just print the plain page file.
+  --print-completion {bash,zsh,tcsh}
+                        print shell completion script
 ```
 
 ## Configuration
@@ -82,17 +91,17 @@ export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zi
 
 Cache is downloaded from `TLDR_DOWNLOAD_CACHE_LOCATION` (defaults to the one described in [the client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#caching)), unzipped and extracted into the [local cache directory](#cache-location). Pages are loaded directly from `TLDR_PAGES_SOURCE_LOCATION` if `tldr <command>` is used.
 
-* `TLDR_CACHE_ENABLED` (default is `1`):
-    * If set to `1`, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old.
-    * If set to `0`, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet.
-* `TLDR_CACHE_MAX_AGE` (default is `168` hours, which is equivalent to a week): maximum age of the cache in hours to be considered as valid when `TLDR_CACHE_ENABLED` is set to `1`.
+- `TLDR_CACHE_ENABLED` (default is `1`):
+    - If set to `1`, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old.
+    - If set to `0`, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet.
+- `TLDR_CACHE_MAX_AGE` (default is `168` hours, which is equivalent to a week): maximum age of the cache in hours to be considered as valid when `TLDR_CACHE_ENABLED` is set to `1`.
 
 #### Cache location
 
 In order of precedence:
-* `$XDG_CACHE_HOME/tldr`
-* `$HOME/.cache/tldr`
-* `~/.cache/tldr`
+- `$XDG_CACHE_HOME/tldr`
+- `$HOME/.cache/tldr`
+- `~/.cache/tldr`
 
 If you are experiencing issues with *tldr*, consider deleting the cache files before trying other measures.
 
@@ -121,37 +130,41 @@ an autocomplete for `tldr` for `fish`.
 
 For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following:
 
-* `TLDR_ALLOW_INSECURE=1` 
+- `TLDR_ALLOW_INSECURE=1` 
 
 will disable SSL certificate inspection. This __should be avoided__ unless absolutely necessary.
 
 ### Colors
 
 Values of the `TLDR_COLOR_x` variables may consist of three parts:
-* Font color: `blue, green, yellow, cyan, magenta, white, grey, red`
-* Background color: `on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green`
-* Additional effects, which depends on platform: `reverse, blink, dark, concealed, underline, bold`
+
+- Font color: `blue, green, yellow, cyan, magenta, white, grey, red`
+- Background color: `on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green`
+- Additional effects, which depend on the platform: `reverse, blink, dark, concealed, underline, bold`
 
 You may specify as many additional effects as you want, while only one of font and background color.
 
-Any of the values of above may be omitted. For example, you can do similar things as the following:
-* `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects
-* `TLDR_COLOR_DESCRIPTION="white"` for white text on default system background color without any effects
-* `TLDR_COLOR_NAME="cyan dark"` for dark cyan text on default system background color
-* `TLDR_COLOR_NAME="on_red"` for default system font color on red background color
-* `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background
-* `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects
+Any of the values above may be omitted. For example, you can do similar things as the following:
+
+- `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects
+- `TLDR_COLOR_DESCRIPTION="white"` for white text on default system background color without any effects
+- `TLDR_COLOR_NAME="cyan dark"` for dark cyan text on default system background color
+- `TLDR_COLOR_NAME="on_red"` for default system font color on the red background color
+- `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background
+- `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects
 
 ### Language
 
-The language that tldr will use is dependent on a number of factors. If you specify a language via the
+The language that tldr will use is dependent on several factors. If you specify a language via the
 `--language` flag, tldr will attempt to use that language and only that language. Otherwise, it will
 try to use the language specified by `TLDR_LANGUAGE`. If it is not set, or the page does not exist in that language,
 then tldr will use the
 language set using `LANGUAGE` and `LANG` (ignoring the values `C` and `POSIX`).
-If neither are set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set,
-first as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE`
-and `en` as fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`).
+
+If neither is set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set,
+first, as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE`
+and `en` as a fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`).
+
 All language values should be set to a value that follows [RFC 1766](https://tools.ietf.org/html/rfc1766.html),
 with the special exceptions of `C` and `POSIX` which are ignored.
 
@@ -160,8 +173,8 @@ with the special exceptions of `C` and `POSIX` which are ignored.
 If you wish to use your own instance of the tldr pages instead of the default repository, you
 can either use the `--source` flag when using tldr or by specifying the following environment variables:
 
-* `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from
-  * defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages`
-  * it can also point to local directory using `file:///path/to/directory`
-* `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from
-  * defaults to `https://tldr-pages.github.io/assets/tldr.zip`
+- `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from.
+  - defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages`.
+  - it can also point to a local directory using `file:///path/to/directory`.
+- `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from.
+  - defaults to `https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip`.