Skip to content

Latest commit

 

History

History
159 lines (118 loc) · 5.84 KB

README.md

File metadata and controls

159 lines (118 loc) · 5.84 KB

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 designed for language enthusiasts, providing romanization for non-Latin scripts.

📝 Table of Contents

🧐 About

This is a browser extension designed 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

  • Edge

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

🖱️ Usage

  1. Open any 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)

    • Initial release with basic functionality
    • Support for Korean (Hangul)

  • 1.1.0 (2025-01-16)

    • Added support for Japanese (Kana-Romaji)

  • 1.2.0 (2025-01-17)

    • UI improvements and i18n support (now supports Chinese, English, Japanese, Korean)

  • 1.2.1 & 1.2.2 (2025-01-23)

    • Added French language support for i18n

  • 1.3.0 & 1.3.1 (2025-02-05)

    • Added support for Mandarin Chinese (Pinyin)
    • Optimized display effect when overflowing

  • 2.0.0 (2025-2-22)

    • Refactored the entire program with React+Plasmo, optimized the running logic
    • Added Toast notifications (when conversion and restoration are completed)
    • Optimized UI styling
    • 2.0.1
      • Adjusted some features according to different browsers
    • 2.0.2
      • Greatly optimized the conversion algorithm to avoid page freezing
      • Fixed UI display issue when resetting settings
    • 2.0.3
      • Met Chrome Web Store review requirements, fixed some bugs

📅 Development Roadmap

🌍 Supported Scripts/Languages

  • Chinese Characters
    • Mandarin Chinese (Supported in v1.3.0)
    • Cantonese
    • Other dialects...
  • Hangul (Korean)
  • 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

  • Add shortcut key support
  • Add feature guide and sample page
  • Add i18n support
  • Add Toast notifications
  • Develop settings page
  • Implement annotation style customization
  • Add pronunciation audio support
  • Add more language support

❓ FAQ

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

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

Q: Does the extension collect user data? A: No. In fact, the extension itself does not need to collect any user data.

🤝 Contributing

Welcome to contribute to the RomanizeMe project! If you have any questions, suggestions or code contributions, please follow these steps:

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

🙏 Acknowledgments

Special thanks to the Pinyin-Pro project, a professional JavaScript library for converting Chinese to pinyin, featuring accurate polyphonic recognition, lightweight, high performance, and rich functionality. Pinyin-Pro is free software that can be used and redistributed under the MIT License.

📜 License

RomanizeMe is distributed under the MIT License.