91fd3fe8ddc65c43eec7b15e7bb4d02935af9b7c

Message

Add TUI commands and file printing features to README

Diff

This diff is truncated to protect this page.

 1diff --git a/README.md b/README.md
 2index 8e8aa8a5b4354726ad4a1d87891d9773792be953..b944629a710cc2c6f563672a774ffa52f7b048d6 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -18,7 +18,8 @@ A tasty, self-hostable Git server for the command line. 🍦
 6 
 7 * Configure with `git`
 8 * Create repos on demand with `git push`
 9-* Browse repos with an SSH-accessible TUI
10+* Browse repos, files and commits with an SSH-accessible TUI
11+* Print files over SSH with or without syntax highlighting and line numbers
12 * Easy access control
13   - Allow/disallow anonymous access
14   - Add collaborators with SSH public keys
15@@ -26,7 +27,21 @@ A tasty, self-hostable Git server for the command line. 🍦
16 
17 ## Where can I see it?
18 
19-Just run `ssh git.charm.sh` for an example.
20+Just run `ssh git.charm.sh` for an example. You can also try some of the following commands:
21+
22+```bash
23+# Jump directly to a repo in the TUI
24+ssh git.charm.sh -t soft-serve
25+
26+# Print out a directory tree for a repo
27+ssh git.charm.sh soft-serve
28+
29+# Print a specific file
30+ssh git.charm.sh soft-serve/cmd/soft/main.go
31+
32+# Print a file with syntax highlighting and line numbers
33+ssh git.charm.sh soft-serve/cmd/soft/main.go -c -l
34+```
35 
36 ## Installation
37 
38@@ -129,6 +144,17 @@ initial public key until you configure things otherwise.
39 If you're having trouble, make sure you have generated keys with `ssh-keygen`
40 as configuration is not supported for keyless users.
41 
42+### Server Settings
43+
44+In addition to the Git-based configuration above, there are a few
45+environment-level settings:
46+
47+* `SOFT_SERVE_PORT`: SSH listen port (_default 23231_)
48+* `SOFT_SERVE_HOST`: SSH listen host (_default 0.0.0.0_)
49+* `SOFT_SERVE_KEY_PATH`: SSH host key-pair path (_default .ssh/soft_serve_server_ed25519_)
50+* `SOFT_SERVE_REPO_PATH`: Path where repos are stored (_default .repos_)