unjs / website

UnJS website Content and Design!
https://unjs.io
Other
124 stars 24 forks source link

Add IPA to READMEs so that everyone can pronounce package names #168

Open NozomuIkuta opened 8 months ago

NozomuIkuta commented 8 months ago

Describe the change

Some UnJS package names are hard to pronounce at first glance (at least for me who is not a native English speaker):

It would be better to add International Phonetic Alphabet in all packages' READMEs, in terms of marketing (people can talk about packages more easily if they can pronounce their names).

For reference, the following sites provide IPA:

URLs

N/A

Additional information


👍 means that it seems obvious how to pronounce it so doesn't need IPA symbols.

### Progress
- [x] api-party 👍
- [x] bundle-runner 👍
- [ ] https://github.com/unjs/c12/pull/118
- [ ] changelogen
- [ ] citty
- [ ] consola
- [x] cookie-es 👍
- [x] create-require 👍
- [ ] db0
- [ ] defu
- [ ] destr
- [x] externality 👍
- [ ] ezpass
- [x] fs-memo 👍
- [x] get-port-please 👍
- [ ] giget
- [x] https://github.com/unjs/h3/pull/569
- [x] hookable 👍
- [x] html-validate-es 👍
- [ ] httpxy
- [x] image-meta 👍
- [ ] ipx
- [x] is-https 👍
- [x] items-promise 👍
- [ ] jimp-compact
- [ ] jiti
- [ ] kachik
- [x] knitwork 👍
- [ ] kvdb
- [ ] listhen
- [ ] lmify
- [ ] magicast
- [ ] mkdist
- [ ] mlly
- [ ] mongoz
- [ ] nitro
- [x] nitro-deploys (covered by nitro)
- [x] nitro-preset-starter (covered by nitro)
- [x] node-fetch-native 👍
- [ ] nypm
- [x] ofetch 👍
- [x] ohash 👍
- [ ] openkv
- [ ] pathe
- [x] perfect-debounce 👍
- [ ] pkg-types
- [ ] radix3
- [ ] rc9
- [x] redirect-ssl 👍
- [ ] requrl
- [x] rollup-plugin-node-deno 👍
- [ ] scule
- [x] serve-placeholder 👍
- [x] shiki-es 👍
- [ ] std-env
- [x] theme-colors 👍
- [ ] ufo
- [x] unbuild 👍
- [x] uncrypto 👍
- [ ] unctx
- [ ] unenv
- [ ] ungh
- [x] unhead 👍
- [x] unimport 👍
- [x] unkit 👍
- [x] unpdf 👍
- [x] unplugin 👍
- [x] unstorage 👍
- [ ] untun
- [x] untyped 👍
- [ ] uqr
- [x] weblint 👍
- [x] webpackbar 👍
- [x] workbox-cdn 👍

Excluded Repositories

Barbapapazes commented 8 months ago

That's a nice idea! 🙌 And yeah, it could really help all of us to know how to pronounce package name.

Could you start this within 1 readme? That way, we'll be able to agree on how to go about it. Once we're ok on 1, let's do every packages.

NozomuIkuta commented 7 months ago

@Barbapapazes

My PR to h3 (https://github.com/unjs/h3/pull/569) has been merged by @pi0, so I believe he is OK with the direction. I will create a task list to the issue description so that we can track the progress.

Barbapapazes commented 7 months ago

@Barbapapazes

My PR to h3 (https://github.com/unjs/h3/pull/569) has been merged by @pi0, so I believe he is OK with the direction. I will create a task list to the issue description so that we can track the progress.

Yes, perfect!