diff --git a/README.en.md b/README.en.md index 02b06ce..7fee0e6 100644 --- a/README.en.md +++ b/README.en.md @@ -4,6 +4,12 @@ Origin Notes is a local-first AI note app built with Electron + Vue 3 + Python. All data stays on your machine by default. +## Project Overview + +- The Electron main process handles window/tray management, the SQLite store, image storage, and backups. The default data directory is `Documents/OriginNotes` (configurable in-app). +- The preload layer exposes IPC via `window.electronAPI`, and the renderer uses Vue 3 + Pinia + TipTap for the note UI. +- The AI backend is FastAPI + LangGraph on `127.0.0.1:8765`, handling chat, vector sync, and RAG search. The renderer calls it over HTTP. + ## Key Features ### Notes diff --git a/README.md b/README.md index 4be144d..2d0acf2 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Origin Notes 是一款本地优先的 AI 笔记应用,基于 Electron + Vue 3 + Python 构建,数据默认保存在本机。 +## 项目概览 + +- Electron 主进程负责窗口/托盘、SQLite 数据库、图片存储与备份,数据目录默认在 `Documents/OriginNotes`(可在应用内迁移)。 +- 预加载脚本通过 `window.electronAPI` 暴露 IPC 能力,渲染进程使用 Vue 3 + Pinia + TipTap 实现笔记 UI。 +- AI 后端为 FastAPI + LangGraph,默认监听 `127.0.0.1:8765`,处理聊天、向量同步与 RAG 检索,前端通过 HTTP 调用。 + ## 核心功能 ### 笔记