Skip to content

docs: add useful project badges to READMEs #26

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.

Sign up for GitHub

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

Merged
yuxino merged 1 commit into from
Sep 27, 2026
Merged

docs: add useful project badges to READMEs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
<p>汉字转拼音首字母，支持中文搜索。</p>
<p><a href="https://pyfl.yuxino.cn">在线试一试</a> · <a href="https://www.npmjs.com/package/pyfl">npm</a> · <a href="https://github.com/yuxino/pyfl/issues">反馈问题</a></p>
<p><strong>简体中文</strong> · <a href="https://github.com/yuxino/pyfl/blob/main/README_en.md">English</a></p>
<p>
<a href="https://www.npmjs.com/package/pyfl"><img src="https://img.shields.io/npm/v/pyfl?logo=npm&amp;logoColor=white&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="npm 版本"></a>
<a href="https://www.npmjs.com/package/pyfl"><img src="https://img.shields.io/npm/dm/pyfl?label=downloads%2Fmonth&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="npm 每月下载次数"></a>
<a href="types/index.d.ts"><img src="https://img.shields.io/badge/TypeScript-types%20included-555?style=flat-square&amp;labelColor=202020&amp;color=555" alt="内置 TypeScript 类型"></a>
<a href="https://github.com/yuxino/pyfl/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/yuxino/pyfl/ci.yml?branch=main&amp;event=push&amp;label=CI&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="main 分支 CI 状态"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/yuxino/pyfl?style=flat-square&amp;labelColor=202020&amp;color=555" alt="MIT 许可证"></a>
</p>
</div>

Pyfl 是一个 JavaScript / TypeScript 库，可以把「你好」转换为 `NH`，用于标题、通讯录和搜索索引。转换在本地完成，没有运行时依赖。现代入口支持词组规则和多读音搜索；默认入口保留原有字表，已有项目可以继续使用。
Expand Down
7 changes: 7 additions & 0 deletions README_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
<p>Convert Chinese text to pinyin initials for search.</p>
<p><a href="https://pyfl.yuxino.cn">Try it online</a> · <a href="https://www.npmjs.com/package/pyfl">npm</a> · <a href="https://github.com/yuxino/pyfl/issues">Report an issue</a></p>
<p><a href="https://github.com/yuxino/pyfl/blob/main/README.md">简体中文</a> · <strong>English</strong></p>
<p>
<a href="https://www.npmjs.com/package/pyfl"><img src="https://img.shields.io/npm/v/pyfl?logo=npm&amp;logoColor=white&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="npm version"></a>
<a href="https://www.npmjs.com/package/pyfl"><img src="https://img.shields.io/npm/dm/pyfl?label=downloads%2Fmonth&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="npm downloads per month"></a>
<a href="types/index.d.ts"><img src="https://img.shields.io/badge/TypeScript-types%20included-555?style=flat-square&amp;labelColor=202020&amp;color=555" alt="TypeScript types included"></a>
<a href="https://github.com/yuxino/pyfl/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/yuxino/pyfl/ci.yml?branch=main&amp;event=push&amp;label=CI&amp;style=flat-square&amp;labelColor=202020&amp;color=555" alt="CI status on main"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/yuxino/pyfl?style=flat-square&amp;labelColor=202020&amp;color=555" alt="MIT license"></a>
</p>
</div>

Pyfl is a JavaScript / TypeScript library that converts Chinese text such as 你好 to pinyin initials such as `NH`, for use in titles, contact lists, and search indexes. Conversion runs locally with no runtime dependencies. Modern entries support phrase rules and searches across alternative pronunciations. The default entry keeps the original dictionary for existing projects.
Expand Down
Loading