From 461d015364e149e0252778ad591d3c68d3540050 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 20 Jun 2025 14:36:28 -0700 Subject: [PATCH] **docs(readme): update deployment instructions for GitHub Pages demo** ### Changes: - Enhanced deployment section in `README.md`: - Added instructions for automatic deployment using the included GitHub Actions workflow (`.github/workflows/deploy-demo.yml`). - Documented steps for configuring a custom domain: - Pointing CNAME or A records to GitHub Pages. - Adding a domain via repository settings. ### Purpose: Improved documentation to guide users in automating GitHub Pages demo deployment and configuring custom domains, simplifying setup and enhancing accessibility for personalized deployments. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 538e8535..832a90a3 100644 --- a/README.md +++ b/README.md @@ -977,6 +977,13 @@ The repository includes a comprehensive demo that showcases Brainy's main featur GitHub Pages - Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details) - To deploy your own version to GitHub Pages, run `npm run deploy:demo` + - To deploy automatically when pushing to the main branch, a GitHub Actions workflow is included in `.github/workflows/deploy-demo.yml` + - To use a custom domain (like www.soulcraft.com): + 1. A CNAME file is already included in the examples directory + 2. In your GitHub repository settings, go to Pages > Custom domain and enter your domain + 3. Configure your domain's DNS settings to point to GitHub Pages: + - Add a CNAME record for www pointing to `.github.io` (e.g., `soulcraft-research.github.io`) + - Or for an apex domain (soulcraft.com), add A records pointing to GitHub Pages IP addresses The demo showcases: