docs: enrich README with full API documentation, usage examples, and showcases

[SoonIter]

Summary

Related issues

AI Summary

---

Enriched the README with comprehensive documentation to improve the developer experience:

• Installation guide: Added npm/pnpm install commands
• Usage examples: Added sections for basic setup, monorepo workspace configuration, custom replacements (replace/replacePost), and serialization hooks (beforeSerialize/afterSerialize)
• Full API reference: Documented all options (root, workspace, replace, replacePost, beforeSerialize, afterSerialize) with types and defaults
• Features table: Listed all 12 toggleable features with descriptions and default values
• Showcases: Added Rspress to the showcase list alongside Rslib, Rsbuild, and Rspack
• License section: Added MIT license link

This PR was written using Vibe Kanban

---

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

此拉取请求旨在全面更新和丰富 README.md 文档，以提供更清晰、更详细的 path-serializer 库的使用指南和功能说明。通过增加安装步骤、多种使用场景示例、详细的配置选项以及更新的项目展示，极大地提升了文档的可用性和可读性，帮助用户更好地理解和应用该库。

Highlights

• 更新了 README 描述: 丰富了 path-serializer 的核心功能描述，并新增了对绝对路径、file:// 协议 URL 和 ANSI 颜色代码处理的说明。
• 新增安装指南: 为 npm 和 pnpm 用户提供了明确的安装命令。
• 扩展用法示例: 增加了针对 Monorepo 工作区、自定义替换规则和序列化钩子的详细使用示例。
• 详细配置选项: 全面介绍了 path-serializer 的所有配置选项，包括 root、workspace、replace、beforeSerialize 等，并详细说明了每个功能的用途。
• 更新项目展示: 扩展了使用 path-serializer 的项目列表，包括 Rslib, Rsbuild, Rspack, Rspress。

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • 更新了库的功能描述，使其更全面。
  • 新增了安装指南。
  • 增加了多种使用场景的示例代码。
  • 详细介绍了所有可用的配置选项及其默认值和描述。
  • 更新了使用该库的项目列表。
  • 新增了许可证信息。

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

这次的 Pull Request 极大地丰富了 README.md 文件，使其内容更全面，对用户也更友好。新增加的安装指南、针对不同场景（基础、Monorepo、自定义替换、钩子）的详细用法示例，以及完整的选项和功能表格，都是非常出色的补充。这些改动将极大地帮助用户理解和有效使用 path-serializer 这个库。我有几个小的建议，可以进一步完善文档。

[Copilot]

Pull request overview

Updates and expands the path-serializer README to better explain what the library does and how to use/configure it for snapshot normalization across test runners.

Changes:

• Replaces the brief feature list with a clearer description, expanded feature bullets, and a before/after snapshot example.
• Adds installation instructions and multiple usage examples (basic, monorepo/workspace, custom replacements, hooks).
• Documents available options and feature flags in a dedicated “Options” section, plus adds more showcase links and a License section.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.