Skip to content

jeffminim/RomanizeMe

Repository files navigation

RomanizeMe - Browser Extension Logo
中文 | English | 日本語 | 한국어 | Français

RomanizeMe - Browser Extension for Romanizing Non-Latin Scripts

Status License Chrome Web Store Edge Add-ons Version


A browser extension for romanizing the pronunciation of non-Latin scripts.

📝 Table of Contents

🧐 About

This is a browser extension for language learners with the following main features:

  • Romanize pronunciation of non-Latin scripts
  • Extensible language support architecture
  • Simple and easy-to-use interface

🏁 Getting Started

🔧 Installation

  • Chrome (Pending Google Chrome Web Store approval)

  • Edge

  • Firefox (Not yet supported. Researching adaptation for Firefox.)

For now, you can manually download the installation package and drag & drop it into your browser to install.

🖱️ Usage

  1. Open a web page containing non-Latin scripts
  2. Click the extension icon in the browser toolbar
  3. Select the script/language you want to romanize
  4. Click "Romanize"
  5. Hover over characters to see their pronunciation

📅 Version History

  • 1.0.0 (2025-01-08)

    • Basic functionality implementation
    • Hangul (Korean) support
  • 1.1.0 (2025-01-16)

    • Japanese Kana (Romaji) support
  • 1.2.0 (2025-01-17)

    • UI optimization and i18n support (Chinese, English, Japanese, Korean)
  • 1.2.1 & 1.2.2 (2025-01-23)

    • i18n support (French added)

📅 Development Roadmap

🌍 Supported Scripts/Languages

  • Hanzi
    • Mandarin (planned for v1.3.0)
    • Cantonese
    • Other dialects...
  • Hangul
  • Japanese
    • Kana (Romaji)
    • Kanji
    • Katakana (original language, e.g. English)
  • Cyrillic
    • Russian
    • Ukrainian
    • Other languages...
  • Arabic
    • Arabic
    • Other languages...
  • Tibetan
  • Other scripts/languages...

✅ TODO List

  • Shortcut key support
  • i18n support
  • Function guide and sample page
  • Settings page development
  • Annotation style customization
  • Pronunciation audio support
  • Support for more languages
  • Adaptation for major browsers

❓ FAQ

Q: Which browsers are supported? A: Currently Chrome and Chromium-based browsers (e.g. Edge) are supported.

Q: How do I update the extension? A: Just download the latest version and reload.

Q: Does the extension collect user data? A: No. In fact, the extension has no need to collect user data.

🤝 Contributing

Contributions to the RomanizeMe project are welcome! If you have questions, suggestions, or code contributions, please follow these steps:

  1. Create an Issue on GitHub describing the problem.
  2. Fork the repository and make changes in your local environment.
  3. Submit a Pull Request with detailed description of your changes.

🙏 Acknowledgments

Thanks to the Tiny Segmenter project. This is a JavaScript library for segmenting Japanese text, providing critical functionality for RomanizeMe. Tiny Segmenter is free software available under the modified BSD license.

📜 License

RomanizeMe is distributed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published