Skip to content

Conversation

@kpal81xd
Copy link
Contributor

@kpal81xd kpal81xd commented Sep 5, 2025

Description

  • Updated README format to match other packages

Checklist

  • I have read the contributing guidelines
  • My code follows the project's coding standards
  • This PR focuses on a single change

@kpal81xd kpal81xd self-assigned this Sep 5, 2025
@kpal81xd kpal81xd added the docs Documentation related label Sep 5, 2025
@kpal81xd kpal81xd requested a review from Copilot September 5, 2025 14:33
Copy link
Contributor

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 updates the README format across multiple language versions to match other packages in the repository. The changes modernize the documentation by replacing the centered layout with inline badges and updating the structure.

  • Replaced centered div layout with inline badge display for NPM stats and social media links
  • Moved documentation links to a table format for better organization
  • Removed reference-style links at the bottom in favor of inline links

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
README.md Updated main English README with new badge layout and inline documentation links
README-zh.md Applied same formatting changes to Chinese version with corrected API reference link
README-kr.md Updated Korean README with new layout and corrected API reference link
README-ja.md Applied formatting changes to Japanese version with corrected API reference link

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

kpal81xd and others added 3 commits September 5, 2025 15:34
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
@kpal81xd kpal81xd merged commit a7acbd9 into main Sep 5, 2025
7 checks passed
@kpal81xd kpal81xd deleted the readme branch September 5, 2025 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants