Skip to content

Commit

Permalink
Rename tldr-man-client to tldr-man
Browse files Browse the repository at this point in the history
  • Loading branch information
superatomic committed Jun 16, 2023
1 parent 1474065 commit 7661e81
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<div>
<h1 align="center">tldr-man-client</h1>
<h1 align="center">tldr-man</h1>
<h5 align="center">A tldr-pages client that works just like <code>man</code></h5>
</div>

`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.

Expand All @@ -24,21 +24,21 @@ 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
```

### 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.

Expand Down
2 changes: 1 addition & 1 deletion src/tldr_man/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 7661e81

Please sign in to comment.