transom 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 the transom authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,45 @@
-# Temporary Holding Version
+# transom
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Postgres, laid out plainly.** One command opens your database in a calm browser tab.
+
+```sh
+npx transom
+```
+
+transom finds the Postgres on your computer (Homebrew, Postgres.app, or `localhost:5432`), lists its databases, and opens your browser. Click one and you're in. It runs on your machine and never writes to your database.
+
+Needs **Node.js 20 or newer**.
+
+```sh
+npx transom postgres://user:password@host:5432/app   # connect straight to a server
+npx transom --port 4000 --no-open                    # fixed port, don't open the browser
+npm install --global transom && transom              # or install it once
+```
+
+| Option | What it does |
+| --- | --- |
+| `postgres://…` | Connect straight to that database instead of showing the connect screen |
+| `--port <n>` | Listen on a fixed port (default: a free one) |
+| `--no-open` | Print the link but don't open the browser |
+| `--help` | Show the options |
+
+## What you get
+
+- **Connect without typing.** Local databases are listed with their sizes and a filter. Any other server works by URL or by host, port and password, and recent connections are one click away.
+- **Every table at a glance**, with row counts and size. Press `/` to filter, `⌘K` to jump anywhere, `⌘B` to collapse the sidebar for more room.
+- **A grid that stays out of the way.** Sort, stack filters, page with the next page preloaded, export CSV. Wide tables scroll sideways with the first column pinned.
+- **Follow the red.** Foreign keys are red links. Click one to open the row it points to, keep going, and see what points back under *Referenced by*.
+- **Structure.** Columns, types, defaults, links between tables, and indexes.
+- **Safe SQL.** Each statement runs in a `READ ONLY` transaction that is rolled back, with a 30-second timeout and history.
+- **Make it yours.** Light or dark; Paper, Slate, Moss or Plum themes; solid, light or minimal sidebar; square, soft or round corners; comfortable or compact rows; Figtree, Inter or your system font. Saved to `~/.config/transom/settings.json`.
+
+## Safety
+
+- The server listens on `127.0.0.1` only and rejects requests addressed to any other hostname.
+- Every request needs a random token from the link transom opens; it changes on every run.
+- Version 0.1 never writes to your database.
+- Passwords stay in memory while transom runs. They're never written to disk or browser storage.
+
+## Licence
+
+MIT. PostgreSQL is a trademark of the PostgreSQL Community Association; transom is an independent project.