docs: add deployment instructions for github pages

Author: sec50

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Trigger the workflow on push to the main branch
+  push:
+    branches: [ main ]
+  # Also allow manual triggering
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: '.'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3

README.md

@@ -81,6 +81,23 @@ Alternatively, you can use any local web server like:
 - PHP: `php -S localhost:8000`
 - Apache: Serve the directory through your local Apache server
 
+## Deployment
+
+This project includes a GitHub Actions workflow for automatic deployment to GitHub Pages:
+
+1. The workflow is defined in `.github/workflows/deploy.yml`
+2. It automatically triggers on pushes to the `main` branch
+3. It can also be manually triggered through the GitHub Actions interface
+
+To enable GitHub Pages deployment:
+
+1. Go to your repository settings
+2. Navigate to "Pages" in the sidebar
+3. Under "Source", select "GitHub Actions"
+4. The site will automatically deploy on the next push to the main branch
+
+The deployed site will be available at `https://<username>.github.io/<repository-name>/`
+
 ## Privacy
 
 CommonKey is designed with privacy in mind: