From 33841cb8ad68f89bb14c8c023a895074ed953693 Mon Sep 17 00:00:00 2001
From: soup <code@soup.land>
Date: Sat, 12 Apr 2025 00:27:47 -0400
Subject: [PATCH] [porthole] Add README

---
 porthole/src/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 porthole/src/README.md

diff --git a/porthole/src/README.md b/porthole/src/README.md
new file mode 100644
index 0000000..6cb68f3
--- /dev/null
+++ b/porthole/src/README.md
@@ -0,0 +1,24 @@
+# porthole
+`porthole` is a simple application to expose services running on your localhost
+via some other host.
+
+## Quickstart
+To use `porthole`, you need to have the server running on a host that is exposed
+to the WWW.
+
+### Server
+To configure the server, run `porthole server configure`. This will prompt you
+for the configuration values you need.
+
+Once configured, you can run `porthole server start` to launch the server.
+
+### Client
+To configure the client, run `porthole client configure`. This will prompt you
+for the configuration values you need.
+
+Once configured, you can run `porthole client start <local_port> [remote_port]`.
+If everything goes well, this will print a `<hostname>:<port>` that should be
+publically accessible!
+
+**NOTE**: `[remote_port]` above is optional. If omitted, a random port will be
+assigned.