From a162675d375e060477a745fa28e6e7b0bd7eaa3d Mon Sep 17 00:00:00 2001
From: Tom Chapin <tchapin@gmail.com>
Date: Thu, 22 Feb 2024 17:43:50 -0800
Subject: [PATCH] removing redundant readme and adding details about tunnel
 expose

---
 01OS/README.md | 55 --------------------------------------------------
 README.md      | 30 +++++++++++++++++++++++----
 2 files changed, 26 insertions(+), 59 deletions(-)
 delete mode 100644 01OS/README.md

diff --git a/01OS/README.md b/01OS/README.md
deleted file mode 100644
index facf81a..0000000
--- a/01OS/README.md
+++ /dev/null
@@ -1,55 +0,0 @@
-The open-source language model computer.
-
-```bash
-pip install 01OS
-```
-
-```bash
-01 # This will run a server + attempt to determine and run a client.
-# (Behavior can be modified by changing the contents of `.env`)
-```
-
-**Expose an 01 server publically:**
-
-We currently support exposing the 01 server publicly via a couple of different tunnel services:
-
-- bore.pub (https://github.com/ekzhang/bore)
-  Requirements: Ensure that rust is installed (https://www.rust-lang.org/tools/install), then run `cargo install bore-cli`
-
-    ```bash
-    01 --server --expose-with-bore
-    ```
-
-- localtunnel (https://github.com/localtunnel/localtunnel)
-  Requirements: Ensure that Node is installed (https://nodejs.org/en/download), then run `npm install -g localtunnel`
-
-    ```bash
-    01 --server --expose-with-localtunnel
-    ```
-
-- ngrok (https://ngrok.com/)
-  Requirements: Install ngrok (https://ngrok.com/docs/getting-started/), and set up an ngrok account.
-  Get your auth key from https://dashboard.ngrok.com/get-started/your-authtoken, then set it in
-  your local configuration by running `ngrok config add-authtoken your_auth_token_here`
-    
-    ```bash
-    01 --server --expose-with-ngrok
-    ```
-
-
-**Run a specific client:**
-
-```bash
-01 --client macos # Options: macos, rpi
-```
-
-**Run locally:**
-
-The current default uses OpenAI's services.
-
-The `--local` flag will install and run the [whisper.cpp](https://github.com/ggerganov/whisper.cpp) STT and [Piper](https://github.com/rhasspy/piper) TTS models.
-
-```bash
-01 --local # Local client and server
-01 --local --server --expose-with-bore # Expose a local server
-```
diff --git a/README.md b/README.md
index fd5fdb3..0492de6 100644
--- a/README.md
+++ b/README.md
@@ -37,9 +37,31 @@ pip install 01OS
 
 **Expose an 01 server publically:**
 
-```bash
-01 --server --expose # This will print a URL that a client can point to.
-```
+We currently support exposing the 01 server publicly via a couple of different tunnel services:
+
+- bore.pub (https://github.com/ekzhang/bore)
+  Requirements: Ensure that rust is installed (https://www.rust-lang.org/tools/install), then run `cargo install bore-cli`
+
+    ```bash
+    01 --server --expose-with-bore
+    ```
+
+- localtunnel (https://github.com/localtunnel/localtunnel)
+  Requirements: Ensure that Node is installed (https://nodejs.org/en/download), then run `npm install -g localtunnel`
+
+    ```bash
+    01 --server --expose-with-localtunnel
+    ```
+
+- ngrok (https://ngrok.com/)
+  Requirements: Install ngrok (https://ngrok.com/docs/getting-started/), and set up an ngrok account.
+  Get your auth key from https://dashboard.ngrok.com/get-started/your-authtoken, then set it in
+  your local configuration by running `ngrok config add-authtoken your_auth_token_here`
+    
+    ```bash
+    01 --server --expose-with-ngrok
+    ```
+
 
 **Run a specific client:**
 
@@ -55,7 +77,7 @@ The `--local` flag will install and run the [whisper.cpp](https://github.com/gge
 
 ```bash
 01 --local # Local client and server
-01 --local --server --expose # Expose a local server
+01 --local --server --expose-with-bore  # Expose the local server with a public tunnel
 ```
 
 **Teach Mode (experimental)**