141138a31df8eaefbe358f450de8cb8074ed4c42

Author
Christian Rocha <christian@rocha.is>
Committer
GitHub <noreply@github.com>
Date

Message

docs: add example images for TUI and file/dir printing

* add image showing file/dir printing
* add TUI image

Diff

 1diff --git a/README.md b/README.md
 2index 8e93dd2feefc38c2af92b668edf20e982d4213fb..d56fcfa21e8fc8362d00013a3709dc071e5bb6e9 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -14,7 +14,7 @@ Soft Serve
 6 
 7 A tasty, self-hostable Git server for the command line. ๐Ÿฆ
 8 
 9-<img src="https://stuff.charm.sh/soft-serve/soft-serve-cli-demo.gif" width="700" alt="Soft Serve screencast">
10+<img src="https://stuff.charm.sh/soft-serve/soft-serve-cli-demo.gif?0" width="750" alt="Soft Serve screencast">
11 
12 * Configure with `git`
13 * Create repos on demand with `git push`
14@@ -173,6 +173,8 @@ git push soft main
15 
16 ## The Soft Serve TUI
17 
18+<img src="https://stuff.charm.sh/soft-serve/soft-serve-tui-diff.png" width="750" alt="TUI example showing a diff">
19+
20 Soft Serve serves a TUI over SSH for browsing repos, viewing files and commits,
21 and grabbing clone commands:
22 
23@@ -189,15 +191,17 @@ ssh localhost -t -p 23231 REPO
24 You can use the `tab` key to move between the repo menu and a particular repo.
25 When a repo is highlighted you can use the following keys for navigation:
26 
27-* `R` - View the project's README file
28-* `F` - Navigate and view all of the files in the project
29-* `C` - View the commit log for the repo
30-* `B` - View branches and tags for the repo
31+* `R` โ€“ View the project's README file
32+* `F` โ€“ Navigate and view all of the files in the project
33+* `C` โ€“ View the commit log for the repo
34+* `B` โ€“ View branches and tags for the repo
35 
36 ## Printing files over SSH
37 
38-Soft Serve gives you the ability to print out files directly from a repo
39-without having to clone or use the TUI.
40+<img src="https://stuff.charm.sh/soft-serve/soft-serve-cat-example.png?1" width="750" alt="Example tree and file output on the CLI">
41+
42+Soft Serve also has the ability to print files and directories directly from a
43+remote repo without the need to clone or use the TUI.
44 
45 To print a file tree for the project, just use the repo name as the SSH command
46 to your Soft Serve server: