Skip to content

Latest commit

 

History

History
132 lines (104 loc) · 8.23 KB

STORE_LISTING.md

File metadata and controls

132 lines (104 loc) · 8.23 KB

Store listing copy: Shirabe Reader

Paste-ready text for the Firefox Add-ons (AMO) and Chrome Web Store dashboards. Keep this file in sync with what's actually submitted; reviewers compare against the previous submission on every update.

Packaging steps live in STORE_RELEASE.md. Build the zips with npm run package:firefox / npm run package:chrome and upload only the artifact from artifacts/<browser>/.


Name

Shirabe Reader

Summary (AMO ≤250 chars · Chrome ≤132 chars)

Short (Chrome, 118 chars):

Read Japanese anywhere. Hover any word for its reading and meaning, and save it straight into your reviews.

Long (AMO, 233 chars):

Read Japanese on any web page. Hover a word to see its reading and meaning, coloured by what you already know, and save it into spaced-repetition reviews without leaving the page. Works offline after a one-time dictionary install.

Category

  • Firefox: Language Support (secondary: Other)
  • Chrome: Education

Description

Read Japanese anywhere on the web.

Shirabe Reader parses Japanese text on any page and gives you the reading and meaning of any word you hover: including inflected forms, which it traces back to the dictionary entry they came from.

Works offline. Install the dictionary pack once and lookup keeps working with no network and no account. Nothing about ordinary reading requires signing in. Stable page text can also use Shirabe's online parser; a setting keeps it on your device.

See what you already know. Connect a Shirabe account and words are coloured by your own knowledge state: new, learning, or known: so you can see at a glance whether a page is at your level.

Save words as you read. One click turns a word into a flashcard with its reading, pitch accent, audio, and the exact sentence you found it in. Reviews use FSRS, a modern spaced-repetition algorithm.

Reads real sites. Ordinary web pages and Japanese Wikipedia, Netflix and YouTube subtitles, asbplayer, and Mokuro manga OCR.

Lookup and page parsing are free. A Shirabe Pro account adds saving words with the sentence they came from, marking words known or ignored, deck selection, and sync.

Open source (GPL-3.0). Deinflection rules ported from Yomitan.

Permission justifications

Reviewers reject vague answers here. Be specific and tie each one to a user-visible feature.

Permission Justification
storage, unlimitedStorage Stores the downloaded Japanese dictionary pack in IndexedDB, plus the user's own settings. The pack is large (hundreds of thousands of entries), which is why unlimited storage is needed. Nothing here leaves the device.
activeTab Lets the toolbar inject the scanner into an already-open page without requiring a reload.
scripting Injects the scanner into an already-open page when the toolbar is opened; the manifest loads it on subsequent pages.
contextMenus Adds a right-click "look up with Shirabe" entry for a selected phrase.
identity Used only for the optional sign-in flow (OAuth redirect back to the extension) when a user chooses to connect a Shirabe account. Not used for ordinary reading.
Host access to shirabe.org, cdn.shirabe.org, t.shirabe.org The API the extension talks to: dictionary pack downloads (cdn.shirabe.org), optional page-text parsing, saving cards and syncing knowledge state (shirabe.org), and error reporting through the first-party PostHog proxy (t.shirabe.org). No other remote host is contacted.
<all_urls> One browser permission for reading on ordinary web pages. Hover lookup reads text under the pointer locally; parsing a whole page requires an explicit command. The popup can pause one tab or turn the reader off for a site.

Data / privacy disclosure

  • Stable page text may be sent to Shirabe for parsing when a signed-in user runs Parse page or Parse selection. Signed out, nothing is sent. Local parsing and dictionary lookup work without an account or network. Turning on Keep page text on this device for parsing stops these requests. Changing subtitle cues and hovered word lookups stay local.
  • Signed-in (optional): words the user chooses to save, with the sentence, page address and page title they came from, and the words they mark known or ignore, are sent to their own Shirabe account. This is the feature the user asked for, not analytics.
  • Error reports include the error class and message, Reader stack frames, the extension version, the browser, and a random session identifier. We do not attach the page URL or looked-up text as report fields. They can be turned off in settings; Firefox also requires its optional technical-data permission.
  • No advertising, no selling of data, no tracking across sites.
  • Privacy policy: https://shirabe.org/en/privacy

Remote code

None. The extension executes no remote JavaScript. Dictionary packs and the /api/v1/reader/host-rules response are schema-validated data only.

Screenshots to capture

Take at a fixed 1280×800 on a light background, same page across both stores:

  1. Hover lookup on an ordinary Japanese article: popup showing reading + meaning.
  2. A parsed page with knowledge-state colouring visible (new / learning / known).
  3. The save-to-deck action with sentence context attached.
  4. Netflix or YouTube subtitle lookup.
  5. The Dictionary tab showing the offline pack installed, with its size and version.

Support links

Reviewer notes (paste into the "notes to reviewer" box)

The extension works fully offline for its core feature. On first run the user installs a Japanese dictionary pack from cdn.shirabe.org, after which lookup needs no network and no account. Stable page text can be sent to Shirabe after a signed-in user explicitly parses a page or selection. The local-only setting stops that request; live subtitle cues stay local.

<all_urls> is requested once when the extension is installed, so hovering a word works on ordinary pages without a permission prompt for each site. The toolbar can pause the current page or turn the reader off for a site.

No remote code is executed. Dictionary packs and host rules are validated data.

To test: open the popup, click "Install dictionary", wait for it to finish, then visit any Japanese page (e.g. https://www3.nhk.or.jp/news/easy/) and hover a word. No account is required for this.