865532e4854a50a1d6646c22e474463651da6c29

Message

docs: update readme

Diff

This diff is truncated to protect this page.

  1diff --git a/README.md b/README.md
  2index 77dcbb8a796b8997b175e12a9cb9e27114e95cbe..da9bb4ce4a3374d2433b06125397e6bdb8c3344a 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -209,8 +209,8 @@ interface to manage access settings, users, and repos.
  6 For more info try `ssh localhost -i ~/.ssh/id_ed25519 -p 23231 help`. Make sure
  7 you use your key here.
  8 
  9-> **Note** The `-i` parts will be omitted in the examples below for
 10-> brevity.
 11+> **Note** The `-i` part will be omitted in the examples below for brevity. You
 12+> can add your server settings to your sshconfig for quicker access.
 13 
 14 ### Access Levels
 15 
 16@@ -273,7 +273,7 @@ SSH Public Key authentication `read-only` access to public repos.
 17 Admins can manage users and manage their keys. Once a user is created and has
 18 access to the server, they can manage their own keys and settings.
 19 
 20-To create a new user use simply use `user create`:
 21+To create a new user simply use `user create`:
 22 
 23 ```sh
 24 # Create a new user
 25@@ -350,8 +350,8 @@ Use "ssh -p 23231 localhost repo [command] --help" for more information about a
 26 
 27 ### Creating Repositories
 28 
 29-To create a repository, first make sure you have at least a `read-write`
 30-permission. You can use the `repo create <repo>`:
 31+To create a repository, first make sure you are an admin or a registered user.
 32+Use the `repo create <repo>` command to create a new repository:
 33 
 34 ```sh
 35 # Create a new repository
 36@@ -365,6 +365,9 @@ ssh -p 23231 localhost repo create icecream '-d "This is an Ice Cream descriptio
 37 
 38 # I need my repository private!
 39 ssh -p 23231 localhost repo create icecream -p '-d "This is an Ice Cream description"' '-n "Ice Cream"'
 40+
 41+# Help?
 42+ssh -p 23231 localhost repo create -h
 43 ```
 44 
 45 Or you can add your Soft Serve server as a remote to any existing repo, given
 46@@ -413,7 +416,7 @@ ssh -p 23231 localhost repo rename iceacream vanilla
 47 Sometimes you want to restrict write access to certain repositories. This can
 48 be achieved by adding a collaborator to your repository.
 49 
 50-Use the `repo collab <repo> <username>` command to add/remove user collaborators.
 51+Use the `repo collab <command> <repo>` command to manage repo collaborators.
 52 
 53 ```sh
 54 # Add collaborator to soft-serve
 55@@ -423,7 +426,7 @@ ssh -p 23231 localhost repo collab add soft-serve frankie
 56 ssh -p 23231 localhost repo collab remove soft-serve beatrice
 57 
 58 # List collaborators
 59-ssh -p 23231 localhost repo collab list
 60+ssh -p 23231 localhost repo collab list soft-serve
 61 ```
 62 
 63 ### Repository metadata
 64@@ -436,7 +439,7 @@ etc using the `repo <command>` command.
 65 ssh -p 23231 localhost repo description icecream "This is a new description"
 66 
 67 # Hide repo from listing
 68-ssh -p 23231 localhost repo icecream hide true
 69+ssh -p 23231 localhost repo hidden icecream true
 70 
 71 # List repository info (branches, tags, description, etc)
 72 ssh -p 23231 localhost repo icecream info
 73@@ -481,8 +484,11 @@ numbers:
 74 
 75 ```sh
 76 ssh -p 23231 localhost repo blob soft-serve cmd/soft/root.go -c -l
 77+
 78 ```
 79 
 80+Use `--raw` to print raw file contents. This is useful for dumping binary data.
 81+
 82 ## The Soft Serve TUI
 83 
 84 <img src="https://stuff.charm.sh/soft-serve/soft-serve-demo-commit.png" width="750" alt="TUI example showing a diff">
 85@@ -490,14 +496,14 @@ ssh -p 23231 localhost repo blob soft-serve cmd/soft/root.go -c -l
 86 Soft Serve serves a TUI over SSH for browsing repos, viewing files and commits,
 87 and grabbing clone commands:
 88 
 89-```
 90+```sh
 91 ssh localhost -p 23231
 92 ```
 93 
 94 It's also possible to “link” to a specific repo:
 95 
 96-```
 97-ssh localhost -t -p 23231 REPO
 98+```sh
 99+ssh -p 23231 localhost -t soft-serve
100 ```
101 
102 You can copy text to your clipboard over SSH. For instance, you can press
103@@ -518,7 +524,7 @@ Until we sort this out you’ll either need an SHA-1 RSA key or a key with
104 another algorithm, e.g. Ed25519. Not sure what type of keys you have?