Updated README.md + deployment

Author: hazeliscoding

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: pages-deploy
+  cancel-in-progress: true
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        env:
+          CI: true
+        run: npm run test
+
+      - name: Build
+        run: npm run build -- --configuration production --base-href /${{ github.event.repository.name }}/
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: dist/kawaii-linktree/browser
+          force_orphan: true

README.md

@@ -1,59 +1,95 @@
-# KawaiiLinktree
+# 🌸 HazelTree
+[![Deploy to GitHub Pages](https://github.com/hazeliscoding/hazel-tree/actions/workflows/deploy.yml/badge.svg)](https://github.com/hazeliscoding/hazel-tree/actions/workflows/deploy.yml)
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.0.3.
+A cute, lightweight Linktree-style profile page built with Angular.
+Content is driven by a single JSON file so you can update links, labels, emojis, and profile info without touching the UI.
 
-## Development server
+> 💻 Platform: **Web** (Angular 21)
+> 
+> ✨ Features: **light/dark theme**, **sparkle cursor**, **copy-to-clipboard links + toast**
 
-To start a local development server, run:
+---
 
-```bash
-ng serve
-```
+## 🛠 Tech Stack
+
+- Angular 21 (standalone components + new control flow)
+- TypeScript
+- RxJS
+- Vitest (via `ng test`)
+- GitHub Pages deploy (`gh-pages`)
 
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
+---
 
-## Code scaffolding
+## 🚀 Running Locally
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+From a terminal in the project root:
 
 ```bash
-ng generate component component-name
+# 1. Install deps
+npm install
+
+# 2. Start dev server
+npm run start
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+Open `http://localhost:4200/`.
 
-```bash
-ng generate --help
-```
+---
+
+## 🧩 Customization (Your Links + Profile)
+
+Edit your content in [public/assets/site-config.json](public/assets/site-config.json).
+
+Supports:
 
-## Building
+- `profile`: name, handle, bio, avatar
+- `links[]`: label, url, emoji, description
+- optional link extras:
+	- `isNew: true` to show a “new” pill
+	- `copyText` to copy text instead of navigating (shows a toast)
 
-To build the project run:
+Notes:
+
+- The app loads config from `assets/site-config.json` (relative), so it works correctly when deployed under a sub-path (GitHub Pages).
+- Put images under `public/assets/` and reference them like `assets/avatar.png`.
+
+---
+
+## 🏗 Building
 
 ```bash
-ng build
+npm run build
 ```
 
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
+Build output goes to `dist/`.
 
-## Running unit tests
+---
 
-To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
+## 🧪 Tests
 
 ```bash
-ng test
+npm run test
 ```
 
-## Running end-to-end tests
+---
+
+## 🌍 Deploying (GitHub Pages)
+
+Deploys happen automatically via GitHub Actions on every push to `main` (or `master`).
+
+The workflow builds with `--base-href /<repo-name>/` automatically (based on the GitHub repository name).
+
+If you haven’t yet, enable GitHub Pages in your repo settings:
+
+- **Settings → Pages → Build and deployment → Source:** `Deploy from a branch`
+- **Branch:** `gh-pages` (root)
 
-For end-to-end (e2e) testing, run:
+This repo includes a deploy script that builds for production and publishes `dist/kawaii-linktree/browser` via `gh-pages`:
 
 ```bash
-ng e2e
+npm run deploy
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+If you’re deploying to a different repo name / sub-path and using the manual script, update the `--base-href` in the `deploy` script in [package.json](package.json).
 
-## Additional Resources
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.