soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

**docs(readme): update deployment instructions for GitHub Pages demo**

Browse source 
### 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.
This commit is contained in:
David Snelling 2025-06-20 14:36:28 -07:00
parent 5cc6f9d683
commit 461d015364
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -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 `<username>.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: