Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: improve and extend README content #157

wants to merge 3 commits into from

Conversation

J3m5
Copy link
Contributor

@J3m5 J3m5 commented Jul 3, 2025

  • πŸ“ 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

@J3m5 J3m5 requested a review from Copilot July 3, 2025 16:06
Copy link

github-actions bot commented Jul 3, 2025

Coverage Report

Status Category Percentage Covered / Total
🟒 Lines 71.35% (🎯 70%) 289 / 405
🟒 Statements 71.39% (🎯 70%) 292 / 409
🟒 Functions 71.64% (🎯 70%) 48 / 67
🟒 Branches 59.63% (🎯 58%) 229 / 384
File CoverageNo changed files found.
Generated in workflow #248 for commit 30a3c1f by the Vitest Coverage Report Action

@J3m5 J3m5 requested review from dunglas and alanpoulain July 3, 2025 16:06
Copy link

@Copilot Copilot AI left a 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.

@api-platform api-platform deleted a comment from Copilot AI Jul 3, 2025
@dunglas
Copy link
Member

dunglas commented Jul 3, 2025

Please remove the HTML. It's useless here and make the file less readable.

@dunglas
Copy link
Member

dunglas commented Jul 3, 2025

The TOC isn't useful either, it is generated automatically by GitHub and our website.

@J3m5
Copy link
Contributor Author

J3m5 commented Jul 4, 2025

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.

@J3m5
Copy link
Contributor Author

J3m5 commented Jul 4, 2025

Please remove the HTML. It's useless here and make the file less readable.

It just doesn’t look as nice to me
image
image

@J3m5
Copy link
Contributor Author

J3m5 commented Jul 4, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants