-
-
Notifications
You must be signed in to change notification settings - Fork 77
chore: improve and extend README content #157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Coverage Report
File CoverageNo changed files found. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR overhauls the README to improve clarity, navigation, and completeness by reorganizing the header, adding new sections, and fixing links.
- Introduce a centered title banner with updated badges and quick links.
- Add "Key Features," expanded installation options (Yarn, Pnpm, Bun), usage examples, and detailed TypeScript definitions.
- Reformat the OpenAPI support details into a rules table and expand sections on contributing, contributors, star history, credits, and license.
Please remove the HTML. It's useless here and make the file less readable.
The TOC isn't useful either, it is generated automatically by GitHub and our website.
The TOC isn't useful either, it is generated automatically by GitHub and our website.
While the TOC is automatically generated by GitHub, it serves as a quick-access navigation shortcut to the most relevant sections.
I've applied your suggestions, @dunglas.
The only HTML left is for the chart history image, since it allows the chart to adapt to dark or light mode based on the user's preference.
except for star history chart
...l available properties
@api-platform/core-team-js
Quick ping: since the last review Iβve made some small changes (usage examples with await + destructured returns, reordered the install section, fixed links, and added a logo).
If thereβs anything else youβd like changed before I merge, just let me know.
Uh oh!
There was an error while loading. Please reload this page.
π Enhanced the README with additional content and sections for better clarity.
π Fixed broken links to ensure all references are valid.
π¨ Reformatted the document for improved readability.
πΌοΈ Added a custom logo
Check the rendered changes
image