Skip to content

Commit a22483d

Browse files
committed
docs(README): add live demo badges + quick links; fix header; DCO sign-off block, normalize headings (remove filename H1s); clean README top section
1 parent 190a19b commit a22483d

5 files changed

Lines changed: 51 additions & 22 deletions

File tree

.github/workflows/gh-pages.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Deploy demos to GitHub Pages
2+
on:
3+
push:
4+
branches: [ feat/builder-ui-v1 ] # change if needed
5+
permissions:
6+
contents: read
7+
pages: write
8+
id-token: write
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-node@v4
15+
with: { node-version: 20 }
16+
- run: npm ci
17+
- run: npm run build
18+
- name: Prepare site
19+
run: |
20+
mkdir -p site/demo
21+
cp -r demo/*.html site/demo/
22+
cp -r dist site/dist
23+
- uses: actions/upload-pages-artifact@v3
24+
with: { path: 'site' }
25+
deploy:
26+
needs: build
27+
runs-on: ubuntu-latest
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
31+
steps:
32+
- id: deployment
33+
uses: actions/deploy-pages@v4

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CODE_OF_CONDUCT.md
1+
# Code of Conduct
22

33
This project follows the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct. By participating, you agree to uphold a harassment‑free, inclusive environment. Reports: open an issue or contact the maintainers privately.
44

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CONTRIBUTING.md
1+
# Contributing
22

33
Thanks for considering a contribution! 🙌 This project welcomes fixes, features, docs, and examples.
44

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1-
# README.md
1+
# formBuilder-ConditionalLogic
22

33
[![DCO](https://img.shields.io/badge/DCO-1.1-blue.svg)](https://developercertificate.org/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
5+
[![Release](https://img.shields.io/github/v/release/jaimonorle/formBuilder-ConditionalLogic?display_name=tag)](https://github.com/jaimonorle/formBuilder-ConditionalLogic/releases)
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
7+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-orange.svg)](https://www.conventionalcommits.org/)
8+
[![Pages](https://github.com/jaimonorle/formBuilder-ConditionalLogic/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/jaimonorle/formBuilder-ConditionalLogic/actions/workflows/gh-pages.yml)
9+
[![Builder Demo](https://img.shields.io/badge/demo-Builder%20Demo-blue.svg)](https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/builder-static.html)
10+
[![Render Demo](https://img.shields.io/badge/demo-Render%20Demo-blue.svg)](https://jaimonorle.github.io/formBuilder-ConditionalLogic/demo/render-static.html)
11+
12+
**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)
13+
414

515
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.
616

@@ -190,29 +200,15 @@ attachLogicGroupsManager(toolbarEl, { getAvailableFields, getFieldValues });
190200
191201
---
192202
193-
### DCO: sign-off required
203+
## Contributing
194204
195-
We follow the **Developer Certificate of Origin**. Please sign off your commits.
196-
197-
```bash
198-
# set your real name and email once (must match sign-off)
199-
git config user.name "Your Real Name"
200-
git config user.email "you@example.com"
201-
202-
# sign off a new commit
203-
git commit -s -m "feat: add Visual Groups Editor"
204-
205-
# if you forgot, amend the last commit
206-
git commit --amend -s --no-edit
207-
# then push safely
208-
git push --force-with-lease
209-
```
205+
We welcome PRs! Please read [CONTRIBUTING.md](CONTRIBUTING.md) and sign off your commits per the [DCO](https://developercertificate.org/).
206+
Also see our [Code of Conduct](CODE_OF_CONDUCT.md), [Security policy](SECURITY.md), and [Changelog](CHANGELOG.md).
210207
211-
Read more: [https://developercertificate.org/](https://developercertificate.org/)
212208
213209
## Acknowledgements
214210
215-
* Inspired by community demand and prior work like **formbuilder_depends**.
211+
* Inspired by community demand and prior work like [**formbuilder_depends**](https://github.com/rendezz/formbuilder_depends).
216212
217213
## License
218214

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SECURITY.md
1+
# Security Policy
22

33
Please report security issues privately via email or a confidential issue. Do not create public issues for vulnerabilities until a fix is available.
44

0 commit comments

Comments
 (0)