Skip to content

Rewrite README: no emoji, no hype, one install path - #4

Merged
alfdav merged 2 commits into
mainfrom
cursor/readme-cleanup-ae76
Aug 15, 2026
Merged

alfdav merged 2 commits into
mainfrom
cursor/readme-cleanup-ae76

Conversation

@alfdav

@alfdav alfdav commented Aug 15, 2026

Copy link
Copy Markdown
Owner

Strips the README down to what a stranger needs to install and run TempFox, then aligns the rest of the live docs with those facts.

  • Removed emoji, the ASCII fox, and marketing adjectives from README.
  • Dropped the false auto-renewal claim. Expired tokens exit.
  • One install section (UV), one usage section, one short dev section. Clone URL is alfdav/TempFox.
  • License points at LICENSE. One-line MIT + a short use-at-your-own-risk note.
  • Documented the flags that exist in tempfox/core.py: --skip-preflight, --version/-v, --list-profiles, --cleanup-profiles, --no-profile.
  • MIGRATION.md: canonical GitHub URL, same Docker one-liner, pip is a one-liner only (not a Python <3.8 workaround or rollback path).
  • TODO.md / project-context / the 2026-02-16 plan note: no retry/renewal.
  • pyproject.toml homepage/repo/issues URLs use alfdav/TempFox.
  • Install-docs tests require the UV path and reject emoji, lowercase clone URLs, auto-renewal, and a pasted MIT grant across the live docs.

make hygiene passed (62 tests). Docs only. Do not merge from this agent.

Open in Web Open in Cursor 

Drop emoji, ASCII art, hype, the false auto-renewal claim, and the
pasted MIT text. Keep one UV install path, the flags that exist in
core.py, and a LICENSE pointer. Lock that contract in the install docs
tests.

Co-authored-by: David Diaz <alfdav@users.noreply.github.com>
@alfdav
alfdav marked this pull request as ready for review August 15, 2026 23:43

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Cursor Bugbot was not present after the first check poll, no approval policy requires human review, and this automation had no prior approval to keep or dismiss. No reviewers were assigned.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

Use the canonical alfdav/TempFox URL, drop the leftover retry/renewal
wording, and stop treating pip as a second installer or a Python <3.8
workaround. Lock those checks across the live docs.

Co-authored-by: David Diaz <alfdav@users.noreply.github.com>
@alfdav
alfdav merged commit eefccea into main Aug 15, 2026
8 checks passed
alfdav added a commit that referenced this pull request Aug 16, 2026
Mark PRs #2#4 shipped in docs; point MIGRATION at make hygiene
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.

2 participants