Skip to content

Commit fc02c92

Browse files
committed
docs(README,contributors): add Live Demos section + quick-link anchor; fix builder snippet (toolbar); add jsDelivr CDN example; add all-contributors section and config
1 parent 5f9a6e4 commit fc02c92

2 files changed

Lines changed: 53 additions & 11 deletions

File tree

.all-contributorsrc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"projectName": "formBuilder-ConditionalLogic",
3+
"projectOwner": "jaimonorle",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": ["README.md"],
7+
"imageSize": 80,
8+
"commit": true,
9+
"commitConvention": "angular",
10+
"contributorsPerLine": 7
11+
}

README.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77

88
[![DCO](https://img.shields.io/badge/DCO-1.1-blue.svg)](https://developercertificate.org/)
9+
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
910
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1011
[![Release](https://img.shields.io/github/v/release/jaimonorle/formBuilder-ConditionalLogic?display_name=tag)](https://github.com/jaimonorle/formBuilder-ConditionalLogic/releases)
1112
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
@@ -14,7 +15,7 @@
1415
[![Builder Demo](https://img.shields.io/badge/demo-Builder%20Demo-blue.svg)](https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/builder-static.html)
1516
[![Render Demo](https://img.shields.io/badge/demo-Render%20Demo-blue.svg)](https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/render-static.html)
1617

17-
**Quick Links:** [Quick Start](#quick-start) · [Demos](#installation) · [Renderer API](#renderer-api) · [Builder API](#builder-api) · [Contributing](CONTRIBUTING.md) · [Code of Conduct](CODE_OF_CONDUCT.md) · [Changelog](CHANGELOG.md) · [Security](SECURITY.md) · [License](LICENSE)
18+
**Quick Links:** [Quick Start](#quick-start) · [Live Demos](#live-demos) · [Renderer API](#renderer-api) · [Builder API](#builder-api) · [Contributing](CONTRIBUTING.md) · [Code of Conduct](CODE_OF_CONDUCT.md) · [Changelog](CHANGELOG.md) · [Security](SECURITY.md) · [License](LICENSE)
1819

1920

2021
A lightweight, name‑based **Conditional Logic** toolkit for [formBuilder](https://github.com/kevinchappell/formBuilder). Add show/hide/require/enable/disable behaviors to fields and containers without writing custom code.
@@ -25,10 +26,13 @@ A lightweight, name‑based **Conditional Logic** toolkit for [formBuilder](http
2526
* **Logic Groups (GUI)** define reusable rule groups in a toolbar modal
2627
* **Name‑based** rules: `hasVehicle`, `FormData12`, `city`, etc. (no class hacks)
2728

28-
> **Demos**: Static UMD pages (work on any static host)
29-
>
30-
> * `demo/builder-static.html` — drag fields, open **Conditional Logic** panel, save
31-
> * `demo/render-static.html` — quick smoke test with `data-logic` attributes
29+
## Live Demos
30+
31+
- **Builder Demo**https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/builder-static.html
32+
Drag fields, open **Conditional Logic** panel, use Visual Rules Editor or Advanced JSON.
33+
- **Render Demo**https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/render-static.html
34+
Minimal form demonstrating `data-logic` attributes in action.
35+
3236

3337
---
3438

@@ -44,19 +48,28 @@ npm run dev
4448

4549
### UMD (Static / CDN / GitHub Pages)
4650

47-
1. Build once:
51+
**Option 1 — use the built bundle from this repo**
4852

4953
```bash
5054
npm run build
55+
# serve /dist and /demo/*-static.html from any static host
5156
```
5257

53-
2. Serve `dist/` + `demo/*-static.html` from any static host.
54-
5558
```html
56-
<!-- UMD global -->
59+
<!-- UMD global (from your repo/dist) -->
5760
<script src="/dist/formbuilder-conditional-logic.umd.cjs"></script>
5861
```
5962

63+
**Option 2 — load from jsDelivr (CDN)**
64+
65+
```html
66+
<!-- Stable by tag -->
67+
<script src="https://cdn.jsdelivr.net/gh/jaimonorle/formBuilder-ConditionalLogic@v0.2.2/dist/formbuilder-conditional-logic.umd.cjs"></script>
68+
69+
<!-- Or always latest (less stable) -->
70+
<script src="https://cdn.jsdelivr.net/gh/jaimonorle/formBuilder-ConditionalLogic/dist/formbuilder-conditional-logic.umd.cjs"></script>
71+
```
72+
6073
---
6174

6275
## Quick Start
@@ -217,9 +230,27 @@ If this project helps you, consider supporting:
217230
218231
## Contributing
219232
220-
We welcome PRs! Please read [CONTRIBUTING.md](CONTRIBUTING.md) and sign off your commits per the [DCO](https://developercertificate.org/).
221-
Also see our [Code of Conduct](CODE_OF_CONDUCT.md), [Security policy](SECURITY.md), and [Changelog](CHANGELOG.md).
233+
We welcome PRs! Please read [CONTRIBUTING.md](CONTRIBUTING.md) and sign off your commits per the [DCO](https://developercertificate.org/). Also see our [Code of Conduct](CODE_OF_CONDUCT.md), [Security policy](SECURITY.md), and [Changelog](CHANGELOG.md).
234+
235+
This project uses the **all-contributors** spec to recognize **code and non-code** contributions. After your PR lands (or even for design/ideas/testing), we’ll add you with the bot. You can also ask the bot yourself in an issue:
236+
237+
```
238+
@all-contributors please add @your-username for code,doc,design,ideas
239+
```
240+
241+
The Contributors table lives below and is managed automatically.
242+
243+
---
244+
245+
## Contributors ✨
246+
247+
Thanks to these wonderful people:
248+
249+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
250+
251+
<!-- ALL-CONTRIBUTORS-LIST:END -->
222252
253+
This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind welcome!
223254
224255
## Acknowledgements
225256

0 commit comments

Comments
 (0)