Skip to content

Commit 7bda83d

Browse files
authored
Feature/ai agent (#24)
* AI agent
1 parent eed1e64 commit 7bda83d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+9673
-2677
lines changed

README.md

Lines changed: 36 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,61 @@
11
# ReadLite - Simple Reading Mode
22

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.
44

5-
## ✨ Key Features
5+
![ReadLite Screenshot](assets/screenshot.png)
66

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
118

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
1614

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
2116

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
2522

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
3924

4025
### Prerequisites
26+
- Node.js (v16+)
27+
- Yarn or npm
4128

42-
- Node.js 16+ and npm/yarn
43-
- Chrome, Edge, or other modern browsers
44-
45-
### Install Dependencies
46-
29+
### Setup
4730
```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
5234

53-
### Development Mode
35+
# Install dependencies
36+
yarn install
5437

55-
```bash
56-
npm run dev
57-
# or
38+
# Start development server
5839
yarn dev
5940
```
6041

61-
### Build Extension
62-
42+
### Build for production
6343
```bash
64-
npm run build
65-
# or
6644
yarn build
6745
```
6846

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
7056

7157
MIT
7258

73-
---
59+
## Translation
7460

75-
*For Chinese version, please see [README.zh.md](README.zh.md)*
61+
- [中文说明](./README.zh.md)

README.zh.md

Lines changed: 36 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,62 @@
11
# ReadLite - 简洁阅读模式
22

3-
ReadLite 是一款注重用户体验的浏览器扩展,为网页内容提供类纸质书籍的简洁排版和沉浸式阅读体验。它能智能提取网页正文,过滤广告和干扰元素,让您专注于内容本身
3+
一款提供清爽无干扰阅读体验的浏览器扩展,具备 AI 文章摘要功能
44

5-
## ✨ 主要功能
5+
![ReadLite截图](assets/screenshot.png)
66

7-
### 📖 智能内容提取
8-
- 使用先进算法自动识别并提取网页主要内容
9-
- 有效过滤广告、弹窗和其他干扰元素
10-
- 支持各类新闻、博客、文档和长文本网站
7+
## 功能特色
118

12-
### 🎨 精美阅读体验
13-
- 提供多种主题:明亮、暗黑、护眼、纸张模式
14-
- 可自定义字体、字号、行间距和页面宽度
15-
- 自动适应不同设备屏幕尺寸,提供最佳阅读效果
9+
- **干净的阅读界面**:将杂乱的网页转换为美观、无干扰的阅读体验
10+
- **AI文章摘要**:获取即时摘要和对正在阅读内容的见解
11+
- **多种主题**:可选择亮色、暗色、棕褐色和纸张模式,满足个人偏好
12+
- **可调整排版**:自定义字体大小、行间距和页面宽度,获得最佳阅读舒适度
13+
- **文章保存**:将文章保存为markdown格式供离线阅读
1614

17-
### 🔤 多语言支持
18-
- 自动检测页面语言并应用最合适的排版规则
19-
- 为中文和英文内容提供专门优化的阅读体验
20-
- 支持中英文界面切换,满足不同用户的偏好
2115

22-
### ⚡ 便捷操作
23-
- 一键调整所有阅读设置
24-
- 自动记忆您的阅读偏好设置
16+
## 使用方法
2517

26-
### 🔒 注重隐私
27-
- 所有功能在本地处理,不传输您的阅读内容
28-
- 无需注册账号即可使用全部功能
29-
- 不收集任何个人数据,保护您的隐私
18+
1. 从Chrome网上应用店安装扩展(即将推出)
19+
2. 浏览任何文章或博客帖子
20+
3. 点击浏览器工具栏中的ReadLite图标
21+
4. 享受清爽的阅读体验
22+
5. 使用AI按钮获取摘要或提问关于文章的问题
3023

31-
## 🚀 使用方法
32-
33-
1. 安装扩展后,浏览任何含有文章的网页
34-
2. 点击工具栏中的 ReadLite 图标
35-
3. 网页将立即转换为舒适的阅读模式
36-
4. 通过设置面板自定义您的阅读体验
37-
38-
## 🛠️ 开发指南
24+
## 开发
3925

4026
### 前提条件
27+
- Node.js (v16+)
28+
- Yarn或npm
4129

42-
- Node.js 16+ 和 npm/yarn
43-
- Chrome、Edge 或其他现代浏览器
44-
45-
### 安装依赖
46-
30+
### 安装
4731
```bash
48-
npm install
49-
#
50-
yarn install
51-
```
32+
# 克隆仓库
33+
git clone https://github.com/yourusername/read-lite.git
34+
cd read-lite
5235

53-
### 开发模式
36+
# 安装依赖
37+
yarn install
5438

55-
```bash
56-
npm run dev
57-
#
39+
# 启动开发服务器
5840
yarn dev
5941
```
6042

61-
### 构建扩展
62-
43+
### 生产构建
6344
```bash
64-
npm run build
65-
#
6645
yarn build
6746
```
6847

69-
## 📄 许可证
48+
## 技术细节
49+
50+
本扩展使用以下技术构建:
51+
- [Plasmo Framework](https://www.plasmo.com/) - 浏览器扩展框架
52+
- [React](https://reactjs.org/) - UI库
53+
- [Mozilla Readability](https://github.com/mozilla/readability) - 内容提取
54+
- [Marked](https://marked.js.org/) - Markdown解析
55+
56+
## 许可证
7057

7158
MIT
7259

73-
---
60+
## 其他语言
7461

75-
*英文版请查看 [README.md](README.md)*
62+
- [English](./README.md)

0 commit comments

Comments
 (0)