139be67800ee6e6cee3a1905d5ae0330d57c0621

Author
Ayman Bagabas <ayman.bagabas@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

doc: update readme (#413)

Diff

  1diff --git a/README.md b/README.md
  2index c02744c5b7b7393eac2404b49f3bc27e4717f7d5..1b1b77127454388923f8b407d950410089e6b114 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -48,6 +48,9 @@ ssh git.charm.sh repo blob soft-serve cmd/soft/root.go
  6 ssh git.charm.sh repo blob soft-serve cmd/soft/root.go -c -l
  7 ```
  8 
  9+Or you can use Soft Serve to browse local repositories using `soft browse
 10+[directory]` or running `soft` within a Git repository.
 11+
 12 ## Installation
 13 
 14 Soft Serve is a single binary called `soft`. You can get it from a package
 15@@ -617,12 +620,39 @@ ssh -p 23231 localhost repo blob soft-serve cmd/soft/root.go -c -l
 16 
 17 Use `--raw` to print raw file contents. This is useful for dumping binary data.
 18 
 19+### Repository webhooks
 20+
 21+Soft Serve supports repository webhooks using the `repo webhook` command. You
 22+can create and manage webhooks for different repository events such as _push_,
 23+_collaborators_, and _branch_tag_create_ events.
 24+
 25+```
 26+Manage repository webhooks
 27+
 28+Usage:
 29+  ssh -p 23231 localhost repo webhook [command]
 30+
 31+Aliases:
 32+  webhook, webhooks
 33+
 34+Available Commands:
 35+  create      Create a repository webhook
 36+  delete      Delete a repository webhook
 37+  deliveries  Manage webhook deliveries
 38+  list        List repository webhooks
 39+  update      Update a repository webhook
 40+
 41+Flags:
 42+  -h, --help   help for webhook
 43+```
 44+
 45 ## The Soft Serve TUI
 46 
 47 <img src="https://stuff.charm.sh/soft-serve/soft-serve-demo-commit.png" width="750" alt="TUI example showing a diff">
 48 
 49-Soft Serve serves a TUI over SSH for browsing repos, viewing files and commits,
 50-and grabbing clone commands:
 51+Soft Serve TUI is mainly used to browse repos over SSH. You can also use it to
 52+browse local repositories with `soft browse` or running `soft` within a Git
 53+repository.
 54 
 55 ```sh
 56 ssh localhost -p 23231
 57diff --git a/browse.tape b/browse.tape
 58new file mode 100644
 59index 0000000000000000000000000000000000000000..ce600be11cafbcaf7a0bb750dcbeaaceb31cfaa7
 60--- /dev/null
 61+++ b/browse.tape
 62@@ -0,0 +1,47 @@
 63+Set Width 1600
 64+Set Height 900
 65+Set FontSize 22
 66+
 67+Output soft-serve-browse.gif
 68+Output soft-serve-frames/
 69+
 70+Type@300ms "soft"
 71+Enter
 72+Sleep 2s
 73+Type@1s "ddd"
 74+Sleep 2s
 75+Type@1s "uuu"
 76+Sleep 2s
 77+Tab@1s
 78+Sleep 1s
 79+Down@300ms 4
 80+Enter
 81+Sleep 1s
 82+Down@300ms 13
 83+Enter
 84+Sleep 1s
 85+Down@300ms 5
 86+Enter
 87+Down@300ms 20
 88+Sleep 2s
 89+Type@500ms "b"
 90+Sleep 2.5s
 91+Down@300ms 50
 92+Sleep 2.5s
 93+Tab@1s
 94+Down@500ms 4
 95+Up@500ms 2
 96+Enter
 97+Down@250ms 50
 98+Sleep 1s
 99+Tab@1s
100+Down@500ms 8
101+Enter
102+Down@250ms 30
103+Tab@2s
104+Down@500ms 5
105+Up@500ms 2
106+Sleep 2.5s
107+Tab@2s
108+Down@500ms 8
109+Sleep 2s