From f4cf65393568824b69b7dba25044e28827721bac Mon Sep 17 00:00:00 2001
From: Cam Sweeney <cpsweene@gmail.com>
Date: Sat, 8 Jun 2024 19:44:37 -0700
Subject: [PATCH] add readme

---
 .github/workflows/release.yml |  9 ++++++---
 README.md                     | 26 ++++++++++++++++++++++++++
 2 files changed, 32 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index d842ecb..8e279d8 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,9 +1,12 @@
 name: release
 
+# on:
+#   push:
+#     tags:
+#       - "*"
 on:
+  pull_request:
   push:
-    tags:
-      - "*"
 
 permissions:
   contents: write
@@ -28,6 +31,6 @@ jobs:
           distribution: goreleaser
           # 'latest', 'nightly', or a semver
           version: '~> v2'
-          args: release --clean
+          args: release --clean --snapshot
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d40b06d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# tofui
+
+tofui (Terminally On Farcaster User Interface) is a TUI for [farcaster](https://www.farcaster.xyz/).
+
+It supports running locally using your own [Neynar](https://neynar.com/) application, or as a hosteds SSH app using [wish](https://github.com/charmbracelet/wish)
+
+## Usage
+
+To use the hosted version, simply ssh into the app using port 42069. Each ssh session interacts receives it's own application, and uses your SSH public key to drive the sign in flow using neynar's [SIWN](https://docs.neynar.com/docs/how-to-let-users-connect-farcaster-accounts-with-write-access-for-free-using-sign-in-with-neynar-siwn).
+```
+ssh -p 42069 tofui.xyz
+```
+
+### Running locally
+
+Running the app locally can be done by downloading the binary from the [releases](https://github.com/treethought/tofui/releases) page or cloning the repo and running `make build`.
+
+Running locally requires your own Neynar application. After creating one, copy [config.yaml.example](./config.yaml.example) to config.yaml and updating with your app's values.
+
+To run as a normal local TUI, simply run `./tofui`.
+
+To serve the app via an SSH server, simply run `tofui ssh` 
+
+
+
+