Skip to content

readme: lead with the problem it solves, in plain words - #79

Merged
krishhgg merged 2 commits into
mainfrom
readme-rewrite
Oct 6, 2026
Merged

krishhgg merged 2 commits into
mainfrom
readme-rewrite

Conversation

@krishhgg

@krishhgg krishhgg commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

The README now opens with the problem tokenstash solves, in a few short lines that read well when shared:

Your AI agent needs your API keys. It doesn't need to see them.

Ask Claude Code, Codex or Cursor to build anything that calls an API, and it stops to ask you to paste a key into the chat. Once you paste it, the key sits in the transcript, the session summary and the model's context. With tokenstash, the agent runs one command instead. The key goes straight into your project's .env.local, and the agent sees only ✓ OPENAI_API_KEY injected.

Paste each key once, in your browser. Every project after that gets it with one click.

What changed

  • Opening. The new opening is the hook quoted above. Every claim in it is something tokenstash does today.
  • Plain language. Each technical term is explained the first time it appears: skill, OS keychain, inbox, card, MCP, Tailscale, the 401 error, dotenv and build attestation.
  • Remote access. Working from another computer over Tailscale now has its own section instead of sitting inside the configuration table.
  • Em dashes. Every em dash is gone from the README, CHANGELOG.md, SECURITY.md, CONTRIBUTING.md, docs/, the issue templates and the before-and-after diagram. Each sentence was rewritten to read without one. The diagram's pending line now says "card" instead of "task". Code, CLI output and the provider registry are handled in a separate PR.

Repository description

Once this merges, the GitHub description becomes:

Your AI agent needs your API keys. It doesn't need to see them. tokenstash writes keys straight into .env.local for Claude Code, Codex, Cursor and Gemini CLI. Paste each key once, in your browser, never in the chat.

The current description has an em dash.

🤖 Generated with Claude Code

RetriggerConfidence Score: 5/5

The PR appears safe to merge; the earlier documentation finding is fixed.

Summary

The PR rewrites the opening of README.md around the problem tokenstash solves.

  • Explains technical terms in plain words.
  • Gives remote access its own section.
  • Removes em dashes from documentation and issue templates.
  • Fixes the earlier wording about which provider checks run before delivery.

No new actionable issues were found in the changes since the last review.

Reviews (2) · Last reviewed commit: "readme: only keys with an unattended che..."

… in the docs

The README opens with what tokenstash is for: an agent needs your API keys
but never needs to see them. Every technical term is explained the first
time it appears, and remote access over Tailscale has its own section. The
docs, the changelog, the issue templates and the before-and-after diagram
lose every em dash, each sentence rewritten to read without one.

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread README.md Outdated
…very

Co-Authored-By: Claude <noreply@anthropic.com>
@krishhgg
krishhgg merged commit a83b25e into main Oct 6, 2026
4 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