|
1 | 1 | # ReadLite - Simple Reading Mode |
2 | 2 |
|
3 | | -ReadLite is a browser extension focused on user experience, providing clean typography and immersive reading experience similar to physical books. It intelligently extracts webpage content, filters out ads and distracting elements, allowing you to focus on the content itself. |
| 3 | +A browser extension that provides a clean, distraction-free reading experience with AI summarization capabilities. |
4 | 4 |
|
5 | | -## ✨ Key Features |
| 5 | + |
6 | 6 |
|
7 | | -### 📖 Smart Content Extraction |
8 | | -- Automatically identifies and extracts main content using advanced algorithms |
9 | | -- Effectively filters out ads, popups, and other distracting elements |
10 | | -- Supports various news sites, blogs, documentation, and long-form content |
| 7 | +## Features |
11 | 8 |
|
12 | | -### 🎨 Beautiful Reading Experience |
13 | | -- Multiple themes: Light, Dark, Sepia, and Paper mode |
14 | | -- Customizable fonts, font sizes, line spacing, and page width |
15 | | -- Automatically adapts to different screen sizes for optimal reading |
| 9 | +- **Clean Reader Interface**: Transform cluttered web pages into a beautiful, distraction-free reading experience |
| 10 | +- **AI Article Summarization**: Get instant summaries and insights about what you're reading |
| 11 | +- **Multiple Themes**: Choose from Light, Dark, Sepia, and Paper themes to suit your preference |
| 12 | +- **Adjustable Typography**: Customize font size, line spacing, and width for optimal reading comfort |
| 13 | +- **Article Saving**: Save articles as markdown for offline reading |
16 | 14 |
|
17 | | -### 🔤 Multilingual Support |
18 | | -- Automatically detects page language and applies appropriate typography rules |
19 | | -- Provides specialized reading experience for Chinese and English content |
20 | | -- Supports switching between Chinese and English interfaces |
| 15 | +## Usage |
21 | 16 |
|
22 | | -### ⚡ Convenient Controls |
23 | | -- One-click adjustment for all reading settings |
24 | | -- Automatically remembers your reading preferences |
| 17 | +1. Install the extension from the Chrome Web Store (coming soon) |
| 18 | +2. Navigate to any article or blog post |
| 19 | +3. Click the ReadLite icon in your browser toolbar |
| 20 | +4. Enjoy a clean reading experience |
| 21 | +5. Use the AI button to get summaries and ask questions about the article |
25 | 22 |
|
26 | | -### 🔒 Privacy Focused |
27 | | -- All features process locally, no transmission of your reading content |
28 | | -- No account registration required for full functionality |
29 | | -- Collects no personal data, protecting your privacy |
30 | | - |
31 | | -## 🚀 How to Use |
32 | | - |
33 | | -1. After installation, browse any page with articles |
34 | | -2. Click the ReadLite icon in the toolbar |
35 | | -3. The page will immediately convert to comfortable reading mode |
36 | | -4. Customize your reading experience through the settings panel |
37 | | - |
38 | | -## 🛠️ Development Guide |
| 23 | +## Development |
39 | 24 |
|
40 | 25 | ### Prerequisites |
| 26 | +- Node.js (v16+) |
| 27 | +- Yarn or npm |
41 | 28 |
|
42 | | -- Node.js 16+ and npm/yarn |
43 | | -- Chrome, Edge, or other modern browsers |
44 | | - |
45 | | -### Install Dependencies |
46 | | - |
| 29 | +### Setup |
47 | 30 | ```bash |
48 | | -npm install |
49 | | -# or |
50 | | -yarn install |
51 | | -``` |
| 31 | +# Clone the repository |
| 32 | +git clone https://github.com/yourusername/read-lite.git |
| 33 | +cd read-lite |
52 | 34 |
|
53 | | -### Development Mode |
| 35 | +# Install dependencies |
| 36 | +yarn install |
54 | 37 |
|
55 | | -```bash |
56 | | -npm run dev |
57 | | -# or |
| 38 | +# Start development server |
58 | 39 | yarn dev |
59 | 40 | ``` |
60 | 41 |
|
61 | | -### Build Extension |
62 | | - |
| 42 | +### Build for production |
63 | 43 | ```bash |
64 | | -npm run build |
65 | | -# or |
66 | 44 | yarn build |
67 | 45 | ``` |
68 | 46 |
|
69 | | -## 📄 License |
| 47 | +## Technical Details |
| 48 | + |
| 49 | +This extension is built with: |
| 50 | +- [Plasmo Framework](https://www.plasmo.com/) - Browser extension framework |
| 51 | +- [React](https://reactjs.org/) - UI library |
| 52 | +- [Mozilla Readability](https://github.com/mozilla/readability) - Content extraction |
| 53 | +- [Marked](https://marked.js.org/) - Markdown parsing |
| 54 | + |
| 55 | +## License |
70 | 56 |
|
71 | 57 | MIT |
72 | 58 |
|
73 | | ---- |
| 59 | +## Translation |
74 | 60 |
|
75 | | -*For Chinese version, please see [README.zh.md](README.zh.md)* |
| 61 | +- [中文说明](./README.zh.md) |
0 commit comments