Skip to content

Simplify the README to install and three commands - #82

Merged
op-q merged 2 commits into
mainfrom
docs/simplify-readme
Sep 16, 2026
Merged

op-q merged 2 commits into
mainfrom
docs/simplify-readme

Conversation

@op-q

@op-q op-q commented Sep 16, 2026

Copy link
Copy Markdown
Owner

The README is now a short summary, the two install commands, and drop, drop send [filepath] and drop recv [code]. The summary tells people to run drop and choose send or receive.

Reviewed and approved in VS Code before this PR was opened.

The second commit adds two interface tasks for a later release to the terminal UI plan and the checklist:

  • File browser keys: enter and → open a folder, and space marks a choice with a radio button.
  • Connection route: show whether a transfer is direct, through n0's relay, or through a Drop relay. Today a direct connection and one through n0's relay both print peer-to-peer.

Documentation only.

🤖 Generated with Claude Code

op-q and others added 2 commits September 16, 2026 17:40
The README had grown into a reference: example output, scripting, exit
codes, relay settings, rendezvous variables, a platform table and Windows
naming rules. It is now what a new user needs: a short summary, the two
install commands, and `drop`, `drop send` and `drop recv`. The summary
leads with `drop`, whose interface asks for everything else.

The fallback is still named where the direct path is described, as
AGENTS.md requires, including that the default relay is n0's and that Drop
runs none. docs/README.md no longer says every CLI option belongs in the
root README; `drop --help` has the full list.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- The file browser: `enter` and `right` open a folder, `space` marks a
  choice with a radio button. The plan notes that `enter` opening folders
  confused the first tester before, so the hint line has to say how to
  select.
- The route in use: direct, through n0's relay, or through a Drop relay.
  Today a direct connection and an n0-relayed one both print
  `peer-to-peer`, because nothing asks iroh which route it took.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@op-q
op-q merged commit 2d46500 into main Sep 16, 2026
15 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant