e04b2fff0658f1a257cd97d0019fbeb63206795a

Author
Toby Padilla <toby@charm.sh>
Committer
Toby Padilla <toby@charm.sh>
Date

Message

Add README

Diff

 1diff --git a/README.md b/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..00a5006c308e81a6d310067297672c89a2a5d07b
 4--- /dev/null
 5+++ b/README.md
 6@@ -0,0 +1,31 @@
 7+# Smoothie
 8+
 9+Distribute your software on the command line with SSH and Git.
10+
11+## What is it
12+
13+Smoothie is a SSH server that hosts a Git server and interactive TUI built from
14+the repos you push to it. Authors can easily push their projects to Smoothie by
15+adding it as a remote and users can clone repos from Smoothie and stay up to
16+date with the TUI as you push commits.
17+
18+## Pushing a repo
19+
20+1. Run `smoothie`
21+2. Add smoothie as a remote on any git repo: `git remote add smoothie ssh://git@localhost:23231/smoothie`
22+3. Push stuff: `git push smoothie main`
23+
24+## Cloning a repo
25+
26+1. You'll need to know the name (for now, it's not listed anywhere): `git clone ssh://git@localhost:23231/smoothie`
27+
28+## Smoothie TUI
29+
30+If you `ssh localhost -p 23231` you'll see a list of the latest commits to the repos you've pushed.
31+
32+## Auth
33+
34+By default anyone can push or pull from the Git repositories. This is mainly
35+for testing, you can also whitelist public keys that have Git write access by
36+creating an authorized keys file with the public key for each author. By
37+default this file is expected to be at `./.ssh/smoothie_git_authorized_keys`.