docs: improve README documentation - #10
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit:807f111f1b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| > [!WARNING] | ||
| > CSS-Diff 目前暂未上架浏览器扩展商店。 | ||
| 从 [Releases](https://github.com/Jevin0/css-diff-devtools/releases) 下载打包后的 zip 文件,然后在浏览器扩展程序页面中手动安装或加载。 |
There was a problem hiding this comment.
Document unpacking the release zip before loading
In the newly added Chinese README, users are told to download the packaged zip and then manually install/load it from the extensions page, but Chrome/Edge's unpacked-extension flow cannot load the .zip artifact directly; it needs to be extracted first and the output directory selected with "Load unpacked". Chinese users following these install steps will be blocked before they can try the extension, so this should explicitly mention unzipping or provide browser-specific package instructions.
Useful? React with 👍 / 👎.
What changed
Why
The previous README only had a short description and minimal usage notes, so it did not clearly communicate the extension's value for frontend debugging or its core workflow.
Impact
Users and contributors get a clearer project overview in both English and Simplified Chinese, with accurate documentation for the current DevTools comparison behavior.
Validation