Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 3.11 KB

File metadata and controls

80 lines (56 loc) · 3.11 KB

YomiRuby (Filipino, 🇵🇭)

YomiRuby Promo

Chrome Web Store

Pangkalahatang-ideya

Ang YomiRuby ay isang production-ready Manifest V3 Chrome extension na nagdadagdag ng furigana sa Japanese kanji gamit ang semantic HTML ruby tags (<ruby>, <rt>, <rp>).

Mga Tampok

  • Annotation per sentence at paragraph.
  • May progress UI, cancel, at restore.
  • May throttle, retry, at backoff para sa Yahoo API quota.
  • Puwedeng i-test ang API key sa Settings page.
  • May demo mode kung wala pang API key.
  • Conservative DOM updates para mabawasan ang layout breakage.

Quick Start

  1. I-clone ang repository na ito.
  2. Buksan ang chrome://extensions.
  3. I-enable ang Developer mode.
  4. I-click ang Load unpacked at piliin ang folder na ito.
  5. Sa Settings, ilagay ang API key, i-click ang Test API Key at Save Settings.
  6. Buksan ang Japanese page at i-click ang Run Annotation Now.

API Key Setup

Architecture

Component Responsibilidad
background.js API calls, pacing/retry, job status
content.js DOM traversal, ruby injection, progress/cancel/restore
popup.* user controls
options.* API key input, validation, test, save
utils/* text/DOM helper utilities

Permissions

Permission Bakit kailangan
storage I-save ang API key, settings, at temporary status
tabs Kontrolin ang active tab at magpadala ng command
scripting Mag-inject ng content script kapag kailangan
<all_urls> Mag-annotate sa general websites
https://jlp.yahooapis.jp/* Tumawag sa Yahoo API

Privacy at Security

  • Buong policy: PRIVACY_POLICY.md
  • User ang nagbibigay ng API key; walang hardcoded key.
  • Ipinapadala lang ang text sa Yahoo API kapag nag-run ng annotation.
  • Walang sariling backend ang YomiRuby para mag-store ng user data.

Limitations

  • Best effort ang furigana alignment at naka-depende sa API tokenization.
  • Maaaring partial lang ang support sa dynamic pages, shadow DOM, at canvas text.
  • Mas mabagal ang malalaking page dahil sa conservative processing.

License

Unlicense. Tingnan ang LICENSE.