Skip to content

Rewrite the README around what users need to know - #147

Merged
squarepots merged 1 commit into
mainfrom
docs/readme-rewrite
Sep 30, 2026
Merged

squarepots merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@squarepots

@squarepots squarepots commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Summary

Rewrite the English and Simplified Chinese READMEs around what a user needs:

  • what GSwitch does, as short bold-led points;
  • install per platform, with the unsigned Windows installer, the WebView2 requirement, and what to do when its download stalls;
  • adding accounts, including Cockpit Tools import: what Find on this computer reads, that it previews before importing, never replaces saved accounts, never changes Cockpit Tools' files, and leaves Cockpit-only data behind;
  • what to do before switching (install Codex, quit it, file-backed sign-in);
  • where credentials are stored and which services GSwitch contacts.

Removed: the OpenAI affiliation disclaimer, the screenshot note, the PowerShell helper section, and the signing-policy link. Short uninstall steps stay because docs/code-signing-policy.md points to them.

Validation

Documentation only. git diff --check passed, and every relative link and image path exists.

Lead with what GSwitch does, then install, adding accounts (including
Cockpit Tools import and what it reads and leaves alone), what to do
before switching, and where data and network traffic go. Add the
WebView2 requirement and what to do when its download stalls. Drop the
affiliation disclaimer, the screenshot note, the PowerShell helper
section, and the signing-policy link, and keep short uninstall steps.
@squarepots
squarepots merged commit b23073b into main Sep 30, 2026
11 checks passed
@squarepots
squarepots deleted the docs/readme-rewrite branch September 30, 2026 17:25
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