Skip to content

Commit 1f09f98

Browse files
author
Top-5
committed
Add deployment badges and documentation for GitHub Actions auto-deploy
1 parent eaa9ee9 commit 1f09f98

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# 🃏 Klondike Solitaire
22
**Modern TypeScript Edition – React + Vite**
33

4+
[![Deploy to GitHub Pages](https://github.com/top-5/klondike/actions/workflows/deploy.yml/badge.svg)](https://github.com/top-5/klondike/actions/workflows/deploy.yml)
5+
[![License](https://img.shields.io/badge/license-Custom%20Non--Commercial-blue.svg)](LICENSE)
6+
47
A modern, type-safe implementation of Classic Klondike Solitaire, built with React, TypeScript, and Vite, featuring beautiful spritesheet cards, intuitive drag & drop, auto-move functionality, and full move validation logic.
58

69
🎮 **[Play Now on GitHub Pages](https://top-5.github.io/klondike/)**
@@ -193,6 +196,23 @@ interface GameState {
193196

194197
Applies transparent glyphs with shadow tint for vibrant Unicode cards.
195198

199+
## 🚀 Deployment
200+
201+
This project uses **GitHub Actions** for automatic deployment to GitHub Pages.
202+
203+
### Automatic Deployment
204+
- Every push to `main` branch triggers the deployment workflow
205+
- The workflow builds the app and publishes to `gh-pages` branch
206+
- Live site updates automatically at: https://top-5.github.io/klondike/
207+
208+
### Manual Deployment (Optional)
209+
```bash
210+
npm run deploy # Build and deploy to GitHub Pages using gh-pages
211+
```
212+
213+
### Workflow Status
214+
Check the [Actions tab](https://github.com/top-5/klondike/actions) to see deployment status and history.
215+
196216
## 🧱 Build & Deployment
197217

198218
```bash

0 commit comments

Comments
 (0)