Add README documentation for all 18 components#234
Merged
Conversation
Every component in the toolkit now has a README with a clear description, installation instructions, quick start example, detailed usage sections with real code examples derived from each component's test suite, an API reference table, and requirements. The two components that already had READMEs (HttpClient, CORSProxy) have been rewritten with the same structure and depth as the rest.
BlockParser, HTML, Encoding, and Polyfill are extracted from WordPress core. XML follows the same architecture. Each now has an Attribution section crediting the original WordPress core work.
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
Every component in the toolkit now ships a README that follows the same structure used by well-known PHP libraries like Guzzle, Flysystem, and Symfony Console:
composer requireone-linerThe 16 components that had no README now have one. The 2 that already had one (HttpClient, CORSProxy) have been rewritten with the same depth and structure.
All examples use PHP 7.2-compatible syntax and follow WordPress coding style (spaces inside parentheses,
$snake_casevariables,snake_case()methods).Test plan