diff --git a/README.md b/README.md index c7cc21e..e3081c8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 🐾 Toes -Toes is a personal web server you run in your home. +Toes is a personal web appliance you run on your home network. Plug it in, turn it on, and forget about the cloud. @@ -8,7 +8,7 @@ Plug it in, turn it on, and forget about the cloud. Toes runs on a Raspberry Pi. You'll need: -- A Raspberry Pi running Raspberry Pi OS +- A Raspberry Pi 5 running the latest Raspberry Pi OS - A `toes` user with passwordless sudo SSH into your Pi as the `toes` user and run: @@ -22,17 +22,17 @@ This will: 1. Install system dependencies (git, fish shell, networking tools) 2. Install Bun and grant it network binding capabilities 3. Clone and build the toes server -4. Set up bundled apps (clock, code, cron, env, stats) +4. Set up bundled apps and tools (clock, code, cron, env, stats) 5. Install and enable a systemd service for auto-start Once complete, visit `http://.local` on your local network. ## features -- Hosts bun/hono/hype webapps - both SSR and SPA. -- `toes` CLI for pushing and pulling from your server. -- `toes` CLI for local dev mode. + +- Effortlessly hosts bun/hype webapps - both SSR and SPA. +- `git push`, Heroku-style deploys - https://toes.local web UI for managing your projects. -- Per-branch staging environments for Claude. +- `toes` CLI for managing your projects. ## cli configuration @@ -44,8 +44,6 @@ TOES_URL=http://192.168.1.50:3000 toes list # connect to IP TOES_URL=http://mypi.local toes list # connect to hostname ``` -set `NODE_ENV=production` to default to `toes.local:80`. - ## fun stuff - textOS (TODO, more?)