diff --git a/README.md b/README.md index f1c0616..76f0266 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@
-

tldr-man-client

+

tldr-man

A tldr-pages client that works just like man
-`tldr-man-client` is a command-line client for [tldr-pages][tldr-pages], +`tldr-man` is a command-line client for [tldr-pages][tldr-pages], a collection of community-maintained help pages for command-line tools. It differs from other clients because it displays its pages as `man` pages. @@ -24,7 +24,7 @@ Features: ### With Homebrew -Install `tldr-man-client` with [Homebrew](https://brew.sh): +Install `tldr-man` with [Homebrew](https://brew.sh): ```shell brew install superatomic/tap/tldr-man @@ -32,13 +32,13 @@ brew install superatomic/tap/tldr-man ### With Pip -Install `tldr-man-client` with pip (version 3.10+): +Install `tldr-man` with pip (version 3.10+): ```shell pip install tldr-man ``` -`tldr-man-client` additionally depends on [`pandoc`](https://pandoc.org/installing.html) being installed. +`tldr-man` additionally depends on [`pandoc`](https://pandoc.org/installing.html) being installed. After installation, you can view a tldr-page with the `tldr` command. diff --git a/src/tldr_man/main.py b/src/tldr_man/main.py index 35fc007..c6e3cb2 100755 --- a/src/tldr_man/main.py +++ b/src/tldr_man/main.py @@ -15,7 +15,7 @@ # limitations under the License. """ -tldr-man-client: Command-line TLDR client that displays tldr-pages as manpages. +tldr-man: Command-line TLDR client that displays tldr-pages as manpages. Depends on pandoc (and man!). Install `pandoc` from https://pandoc.org/installing.html.