docs: standardize README.md structure#82
Merged
Conversation
Align README with the WebFiori ecosystem standard (webfiori/collections): - Plain markdown headers (no emoji) - Centered badges with PHP 8.1+ badge - Table of Contents - Supported PHP Versions table - Key Features bullet list - Quick Start with working example - Testing, Contributing, License, Support, Changelog sections Closes #54
usernane
force-pushed
the
docs/standardize-readme
branch
from
af874fa to
f5d3734
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #82 +/- ##
============================================
- Coverage 98.43% 98.38% -0.05%
- Complexity 978 979 +1
============================================
Files 7 7
Lines 1975 1977 +2
============================================
+ Hits 1944 1945 +1
- Misses 31 32 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
added 4 commits
June 10, 2026 17:47
Add self-contained, runnable examples following the webfiori/database pattern (folder per example with README.md and example.php): - 01-basic-document: Complete HTML5 document creation - 02-elements-and-attributes: Chaining, styles, iteration - 03-forms-and-input: Form building with various input types - 04-tables: Table creation and dynamic columns - 05-html-templates: Slot-based HTML templates - 06-php-templates: PHP templates with logic - 07-standalone-renderer: HtmlRenderer per-instance config - 08-xml-output: XML generation
When an HTMLNode instance is passed as a slot value, render it as raw
HTML instead of escaping it. String values remain escaped via
htmlspecialchars() for XSS safety.
Usage:
$badge = new HTMLNode('span', ['class' => 'badge']);
$badge->text('New');
$card = HTMLNode::fromFileAsNode('card.html', ['title' => $badge]);
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrite README.md to follow the WebFiori ecosystem standard (matching webfiori/collections).
Motivation
README structure was inconsistent with the ecosystem standard. Fixes #54.
Changes
Checklist
Related issues
Closes #54