Summary

This project addresses English reading comprehension difficulties caused by long, complex sentences and unfamiliar vocabulary. It provides a Chrome extension that automatically breaks down lengthy sentences into digestible chunks and offers contextual vocabulary definitions. Targeted at language learners and avid web readers, the extension enhances comprehension and vocabulary acquisition by processing all data locally, eliminating the need for registration or external data transmission.

How It Works

The core of the project is a client-side Chrome extension built with TypeScript and React, utilizing Manifest V3. It automatically segments complex sentences on any English webpage, preserving structural cues, and highlights unknown words. Hovering over these words reveals definitions from an integrated, offline dictionary containing over 31,000 entries. An optional feature allows integration with various LLM APIs (Gemini, OpenAI, etc.) for advanced sentence analysis and writing style suggestions, with user API keys stored securely and locally. This architecture prioritizes user privacy, ensuring all data, including learning progress and API keys, remains within the user's browser via IndexedDB.

Quick Start & Requirements

Installation is recommended via the Chrome Web Store or Edge Add-ons (currently pending review). Alternatively, users can download a .zip file from the GitHub Releases page and load it as an unpacked extension in developer mode (chrome://extensions/). Building from source requires cloning the repository and running npm install followed by npm run build. Prerequisites include a compatible browser (Chrome/Edge); Node.js and npm are necessary for source builds. Optional LLM API keys are required for advanced AI features.

Highlighted Details

• Features an extensive 31,000+ entry offline dictionary for instant vocabulary lookups without internet access.
• Integrates with multiple LLM providers (Gemini, OpenAI, DeepSeek, Qwen, Kimi) for advanced sentence analysis and writing suggestions.
• Includes a "Daily Review" mode designed to practice sentence segmentation intuition in a low-pressure environment.

Maintenance & Community

The project is personally maintained by CapeAga. External Pull Requests are not accepted; feedback, suggestions, and bug reports are managed through GitHub Issues.

Licensing & Compatibility

The project is licensed under the Business Source License 1.1 (BSL 1.1). This license permits public access to the code but restricts its use as a product or service, prohibiting commercial offerings based on the software or its derivatives. Compatibility for closed-source linking is generally permissible, but commercial deployment requires careful adherence to BSL terms.

Limitations & Caveats

Availability on official Chrome/Edge stores is pending review. Community contributions are limited to feedback via GitHub Issues, as Pull Requests are not accepted. Advanced LLM features require users to provide their own API keys and manage associated costs. The BSL 1.1 license imposes restrictions on commercial use cases.