docs(readme): follow Quick Start with one-click deploy options by cosark · Pull Request #253 · TNT-Likely/PanWatch · GitHub
Skip to content

docs(readme): follow Quick Start with one-click deploy options - #253

Open
cosark wants to merge 1 commit into
TNT-Likely:mainfrom
cosark:add-one-click-deploy
Open

cosark wants to merge 1 commit into
TNT-Likely:mainfrom
cosark:add-one-click-deploy

Conversation

@cosark

@cosark cosark commented Oct 20, 2026

Copy link
Copy Markdown

Background

The README has no one-click way to deploy PanWatch on a hosting provider.

Changes

I added a One-Click Deploy section after Quick Start with buttons for RepoCloud and Railway, plus a matching entry in the top navigation row.
This gives the community one-click access to deploy PanWatch at several hosting providers, each as a ready-made template that needs no other instructions.
Railway: login credentials are preset by the template (notes).

Scope

Documentation only: README.md gains one section and one navigation entry, with no code, dependency or configuration change.

Validation

Tested commit: cb78b63
Commands and results: diff of README.md against upstream main shows a new 8-line section and one changed line (the navigation row); curl returns HTTP 200 for both deploy pages and both button images. Application tests do not apply to a README-only change.

Acceptance evidence

Steps: Open the README on my fork branch (link below) and go to the new section.
Expected: A One-Click Deploy section after Quick Start with two buttons that open each provider's PanWatch page, and a matching navigation entry.
Observed: Both buttons render side by side at the tested commit and link to each provider's PanWatch page, and the navigation entry resolves like the existing ones.
Evidence: https://github.com/cosark/PanWatch/blob/add-one-click-deploy/README.md%23one-click-deploy

Boundaries and risks

No runtime impact. README.zh-CN.md is not changed, and the Railway template pins image tag 0.14.0.

Follow-up

None.

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