From efd814bbff87ae4af19771015d12a8a37bbb430f Mon Sep 17 00:00:00 2001 From: David Snelling Date: Mon, 23 Jun 2025 10:47:44 -0700 Subject: [PATCH] **docs(readme): format live demo section and update `.npmignore`** ### Changes: - **README.md**: - Reformatted "Live Demo" and "Demo" sections for improved readability. - Adjusted line wrapping to enhance clarity and maintain consistent formatting. - **.npmignore**: - Allowed inclusion of `brainy.png` while preserving exclusions for other `.png` files. - **src/utils/version.ts**: - Bumped version from `0.9.0` to `0.9.1`. ### Purpose: Enhanced documentation formatting for better user experience and easier navigation. Updated `.npmignore` to refine file inclusion for package distribution. Incremented version to `0.9.1` to reflect the latest changes. --- .npmignore | 2 ++ README.md | 13 ++++++++----- src/utils/version.ts | 2 +- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.npmignore b/.npmignore index 3e29ae2d..6f0c1c6c 100644 --- a/.npmignore +++ b/.npmignore @@ -25,6 +25,8 @@ coverage/ .nyc_output/ # Large files +# Include the logo but exclude other PNGs +!brainy.png *.png encoded-image.* README.demo.md diff --git a/README.md b/README.md index 513d871d..3fd00a6e 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,8 @@ it gets - learning from your data to provide increasingly relevant results and c ## 🚀 Live Demo -**[Try the live demo](https://soulcraft-research.github.io/brainy/examples/)** - Check out the interactive demo on GitHub Pages that showcases Brainy's main features. You can access it at either [https://soulcraft-research.github.io/brainy/examples/](https://soulcraft-research.github.io/brainy/examples/) or [https://soulcraft-research.github.io/brainy/examples/demo.html](https://soulcraft-research.github.io/brainy/examples/demo.html). +**[Try the live demo](https://soulcraft-research.github.io/brainy/examples/)** - Check out the interactive demo on +GitHub Pages that showcases Brainy's main features. ## 📊 What Can You Build? @@ -977,17 +978,19 @@ the [Cloud Wrapper README](cloud-wrapper/README.md) for detailed configuration i The repository includes a comprehensive demo that showcases Brainy's main features: - `examples/demo.html` - A single demo page with animations demonstrating Brainy's features. - - **[Try the live demo](https://soulcraft-research.github.io/brainy/examples/demo.html)** - Check out the interactive demo on + - **[Try the live demo](https://soulcraft-research.github.io/brainy/examples/demo.html)** - Check out the + interactive demo on 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 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 + - 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: diff --git a/src/utils/version.ts b/src/utils/version.ts index 2ff38acc..fd9cc8a9 100644 --- a/src/utils/version.ts +++ b/src/utils/version.ts @@ -3,4 +3,4 @@ * Do not modify this file directly. */ -export const VERSION = '0.9.0'; +export const VERSION = '0.9.1';