From e04b2fff0658f1a257cd97d0019fbeb63206795a Mon Sep 17 00:00:00 2001 From: Toby Padilla Date: Fri, 30 Jul 2021 18:31:55 -0500 Subject: [PATCH] Add README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..00a5006c3 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Smoothie + +Distribute your software on the command line with SSH and Git. + +## What is it + +Smoothie is a SSH server that hosts a Git server and interactive TUI built from +the repos you push to it. Authors can easily push their projects to Smoothie by +adding it as a remote and users can clone repos from Smoothie and stay up to +date with the TUI as you push commits. + +## Pushing a repo + +1. Run `smoothie` +2. Add smoothie as a remote on any git repo: `git remote add smoothie ssh://git@localhost:23231/smoothie` +3. Push stuff: `git push smoothie main` + +## Cloning a repo + +1. You'll need to know the name (for now, it's not listed anywhere): `git clone ssh://git@localhost:23231/smoothie` + +## Smoothie TUI + +If you `ssh localhost -p 23231` you'll see a list of the latest commits to the repos you've pushed. + +## Auth + +By default anyone can push or pull from the Git repositories. This is mainly +for testing, you can also whitelist public keys that have Git write access by +creating an authorized keys file with the public key for each author. By +default this file is expected to be at `./.ssh/smoothie_git_authorized_keys`.