Skip to content

docs: clarify Quick Start sections in README#124

Merged
Scottcjn merged 1 commit intoScottcjn:mainfrom
yw13931835525-cyber:docs/clarify-quickstart-sections
Mar 5, 2026
Merged

docs: clarify Quick Start sections in README#124
Scottcjn merged 1 commit intoScottcjn:mainfrom
yw13931835525-cyber:docs/clarify-quickstart-sections

Conversation

@yw13931835525-cyber
Copy link
Contributor

This PR improves README usability by clarifying the two Quick Start flows:

  • Keep the webhook flow as the primary 2-minute setup
  • Rename the second section to LAN Quick Start (UDP)
  • Add one-line context so users know when to use each path

Why: there were two similarly named quick-start sections, which could confuse first-time users.

No code changes; docs-only.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to beacon-skill! Thanks for your first pull request.

Quick checklist:

  • Tests pass (pytest tests/)
  • New code includes SPDX license header
  • Focused on a single change

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100)

A maintainer will review your PR soon!

@Scottcjn Scottcjn merged commit 5320451 into Scottcjn:main Mar 5, 2026
2 checks passed
@Scottcjn
Copy link
Owner

Scottcjn commented Mar 5, 2026

Merged! Good clarification distinguishing LAN vs webhook quick start. 1 RTC sent to yw13931835525-cyber wallet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants