Documentation Location
README.md
Version
Current (main branch)
Issue Description
The README structure is inconsistent with the standard adopted across the WebFiori ecosystem (based on webfiori/http).
Current issues:
- Missing "License" section
- Missing "Support" section
- Missing "Changelog" section
- Missing "Contributing" section (has a note at end but not a formal section)
Suggested Improvement
Restructure the README to follow the ecosystem standard:
- Title + one-line description
- Centered badges (CI, Codecov, SonarCloud, Release, Downloads)
- Table of Contents
- Supported PHP Versions (build status table)
- Key Features (bullet list)
- Installation (
composer require)
- Quick Start / Basic Usage (working code examples)
- [Library-specific sections]
- Testing
- Examples (link to examples directory)
- Contributing
- License
- Support (issues link)
- Changelog
Documentation Location
README.md
Version
Current (main branch)
Issue Description
The README structure is inconsistent with the standard adopted across the WebFiori ecosystem (based on webfiori/http).
Current issues:
Suggested Improvement
Restructure the README to follow the ecosystem standard:
composer require)