**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.
This commit is contained in:
parent
26961d0eb2
commit
efd814bbff
3 changed files with 11 additions and 6 deletions
|
|
@ -25,6 +25,8 @@ coverage/
|
||||||
.nyc_output/
|
.nyc_output/
|
||||||
|
|
||||||
# Large files
|
# Large files
|
||||||
|
# Include the logo but exclude other PNGs
|
||||||
|
!brainy.png
|
||||||
*.png
|
*.png
|
||||||
encoded-image.*
|
encoded-image.*
|
||||||
README.demo.md
|
README.demo.md
|
||||||
|
|
|
||||||
13
README.md
13
README.md
|
|
@ -40,7 +40,8 @@ it gets - learning from your data to provide increasingly relevant results and c
|
||||||
|
|
||||||
## 🚀 Live Demo
|
## 🚀 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?
|
## 📊 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:
|
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.
|
- `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
|
GitHub Pages
|
||||||
- Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
|
- 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 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):
|
- To use a custom domain (like www.soulcraft.com):
|
||||||
1. A CNAME file is already included in the examples directory
|
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
|
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:
|
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`)
|
- 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
|
- Or for an apex domain (soulcraft.com), add A records pointing to GitHub Pages IP addresses
|
||||||
|
|
||||||
The demo showcases:
|
The demo showcases:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,4 +3,4 @@
|
||||||
* Do not modify this file directly.
|
* Do not modify this file directly.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const VERSION = '0.9.0';
|
export const VERSION = '0.9.1';
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue