Skip to content

Commit 613ed4b

Browse files
authored
docs: improve readme (#204)
Signed-off-by: Carlos Alexandro Becker <[email protected]>
1 parent 8a42324 commit 613ed4b

File tree

1 file changed

+7
-34
lines changed

1 file changed

+7
-34
lines changed

README.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,5 @@
11
# Wishlist
22

3-
<!--toc:start-->
4-
5-
- [Wishlist](#wishlist)
6-
- [Installation](#installation)
7-
- [Usage](#usage)
8-
- [CLI](#cli)
9-
- [Remote](#remote)
10-
- [Local](#local)
11-
- [Library](#library)
12-
- [Auth](#auth)
13-
- [Local mode](#local-mode)
14-
- [Server mode](#server-mode)
15-
- [Agent forwarding example](#agent-forwarding-example)
16-
- [Discovery](#discovery)
17-
- [Tailscale](#tailscale)
18-
- [Zeroconf/Avahi/mDNS/Bonjour](#zeroconfavahimdnsbonjour)
19-
- [SRV records](#srv-records)
20-
- [Hints](#hints)
21-
- [Running it](#running-it)
22-
- [Using the binary](#using-the-binary)
23-
- [Using Docker](#using-docker)
24-
- [Supported SSH Options](#supported-ssh-options)
25-
- [Acknowledgments](#acknowledgments)
26-
- [Feedback](#feedback)
27-
- [License](#license)
28-
29-
<!--toc:end-->
30-
313
<p>
324
<a href="https://github.com/charmbracelet/wishlist/releases"><img src="https://img.shields.io/github/release/charmbracelet/wishlist.svg" alt="Latest Release"></a>
335
<a href="https://pkg.go.dev/github.com/charmbracelet/wishlist?tab=doc"><img src="https://godoc.org/github.com/golang/gddo?status.svg" alt="GoDoc"></a>
@@ -37,16 +9,17 @@
379

3810
The SSH directory ✨
3911

40-
![screencast](https://user-images.githubusercontent.com/42545625/176265745-1749c5ae-bf8d-460f-865c-fae0e45cb448.gif)
12+
![Gif](https://vhs.charm.sh/vhs-3YDAKLasKh7IgWNTkHKrHB.gif)
4113

42-
With Wishlist you can have a single entrypoint for multiple SSH endpoints,
14+
With Wishlist you can have a single entry point for multiple SSH endpoints,
4315
whether they are [Wish](https://github.com/charmbracelet/wish) apps or not.
4416

4517
As a server, it can be used to start multiple SSH apps within a single package
46-
and list them over SSH. You can list apps provided elsewhere, too.
18+
and list them over SSH.
19+
You can list apps provided elsewhere, too.
4720

48-
You can also use the `wishlist` CLI to list and connect to servers in your
49-
`~/.ssh/config` or, a YAML config file.
21+
You can also use the `wishlist` command to list and connect to servers in your
22+
`~/.ssh/config` or in a YAML configuration file.
5023

5124
## Installation
5225

@@ -83,7 +56,7 @@ sudo yum install wishlist
8356

8457
Or download a pre-compiled binary or package from the [releases][releases] page.
8558

86-
Or just build it yourself (requires Go 1.18+):
59+
Or just build it yourself (requires Go 1.19+):
8760

8861
```bash
8962
git clone https://github.com/charmbracelet/wishlist.git

0 commit comments

Comments
 (0)