Skip to content

docs: polish README, add contributing guide and issue templates - #1

Merged
brentc22 merged 1 commit into
mainfrom
docs/readme-polish
Sep 24, 2026
Merged

brentc22 merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@brentc22

Copy link
Copy Markdown
Owner

Summary

  • README: badges (release, CI, macOS, Swift, license), direct download link, features as a table, numbered install steps, notarization note as a callout
  • New menu screenshot: shows vite, wrangler, supabase, storybook instead of http.server everywhere
  • scripts/demo.sh: fake servers now run as node_modules/.bin/<tool>, so Portside labels them like the real thing. This also fixes demo.sh stop, which never found the servers (Homebrew python re-execs itself via Python.app and loses the exec -a name)
  • CONTRIBUTING.md, issue forms (bug/feature), PR template

Test plan

  • make test: 24 passed
  • scripts/demo.sh → 5 listeners with the right argv; scripts/demo.sh stop → 0 left
  • Check the README render on the PR page (badges, callout, table)

🤖 Generated with Claude Code

- README: badges, direct download link, feature table, install steps
- New menu screenshot showing vite/wrangler/supabase/storybook labels
- demo.sh: disguise servers as node_modules/.bin/<tool> so the screenshot
  shows real tool names; also fixes `stop`, which missed servers because
  Homebrew python re-execs and drops the `exec -a` name
- CONTRIBUTING.md, bug/feature issue forms, PR template

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@brentc22
brentc22 merged commit 32a2835 into main Sep 24, 2026
1 check passed
@brentc22
brentc22 deleted the docs/readme-polish branch September 24, 2026 13:17
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