From 9fc0d51b7eb3740a6968e19d17917edcc78ef003 Mon Sep 17 00:00:00 2001 From: dvsxt Date: Fri, 28 Aug 2026 09:26:34 +0800 Subject: [PATCH] docs: rewrite README in English (v5.0.1) --- README.md | 121 +++++++++++++++++++++++++++--------------------------- 1 file changed, 60 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index ec014c4..74683dd 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,77 @@ +# ☁️ CloudNote - End-to-End Encrypted Cloud Notes Client -☁️ CloudNote - 端到端加密云笔记客户端 -==================================== +A privacy-focused desktop cloud note application using **AES-256-GCM + X25519 elliptic curve encryption** for true end-to-end encryption. The server only stores encrypted data and cannot decrypt user note content. -一个注重隐私保护的桌面云笔记应用程序，采用 AES-256-GCM + X25519 -椭圆曲线加密，实现真正的端到端加密。服务器仅存储加密数据， -无法解密用户笔记内容。 +--- -✨ 核心特性 ------------ -✓ 端到端加密 - 笔记在本地加密后上传，服务器永不见明文 -✓ 混合加密体系 - X25519密钥交换 + AES-256-GCM对称加密 -✓ 灵活密钥管理 - 支持全局密钥/单文件密钥/密码保护三种模式 -✓ 双因素保护 - 可同时使用密码+单独密钥文件保护敏感笔记 -✓ 零知识架构 - 服务器不存储任何解密密钥 -✓ 跨平台支持 - Windows/Linux/macOS +## ✨ Core Features -🔐 加密算法 ------------ -- 密钥交换: X25519 (椭圆曲线Diffie-Hellman) -- 对称加密: AES-256-GCM (认证加密) -- 非对称加密: RSA-2048 (可选) -- 密钥派生: PBKDF2 (100,000次迭代) +| Feature | Description | +|---------|-------------| +| ✓ End-to-End Encryption | Notes are encrypted locally before upload; the server never sees plaintext | +| ✓ Hybrid Encryption | X25519 key exchange + AES-256-GCM symmetric encryption | +| ✓ Flexible Key Management | Global key / per-file key / password protection modes | +| ✓ Two-Factor Protection | Combine password + separate key file to protect sensitive notes | +| ✓ Zero-Knowledge Architecture | The server stores no decryption keys | +| ✓ Cross-Platform | Windows / Linux / macOS | -🛠️ 技术栈 ------------ -- 语言: Python 3.8+ -- GUI框架: PyQt5 -- 加密库: cryptography -- 网络请求: requests +--- -🛡️ 安全原则 ------------ -1. 信任无需要 - 服务器默认不可信 -2. 密钥属用户 - 所有密钥仅存在于客户端 -3. 加密在本地 - 明文永不离开用户设备 -4. 开源可验证 - 代码完全开源，接受安全审计 +## 🔐 Encryption Algorithms -📄 许可证 ---------- -Apache License 2.0 +- **Key Exchange**: X25519 (Elliptic Curve Diffie-Hellman) +- **Symmetric Encryption**: AES-256-GCM (Authenticated Encryption) +- **Asymmetric Encryption**: RSA-2048 (optional) +- **Key Derivation**: PBKDF2 (100,000 iterations) + +--- + +## 🛠️ Tech Stack + +- **Language**: Python 3.8+ +- **GUI Framework**: PyQt5 +- **Encryption Library**: cryptography +- **HTTP Client**: requests + +--- + +## 🛡️ Security Principles + +1. **Trust Not Needed** — The server is untrusted by default +2. **Keys Belong to User** — All keys exist only on the client +3. **Encrypt Locally** — Plaintext never leaves the user's device +4. **Open Source Verifiable** — Fully open source, open to security audit + +--- + +## 📄 License + +This project is licensed under the **Apache License 2.0**. + +--- + +## 👤 Author -👤 作者 -------- dvsxt -🔗 仓库地址 ------------ +## 🔗 Repository + https://gitcode.com/dvsxt/cloudnote +--- -## 🎵 致音乐爱好者 +## 🎵 For Music Lovers -> *写笔记时想听点音乐？试试我的另一个项目——* +> *Want to listen to some music while taking notes? Try my other project —* -### 🔊 ap_ds · 轻量级 Python 音频革命 +### 🔊 ap_ds · The Lightweight Python Audio Revolution -**2.5MB** 终结 FFmpeg **160MB** 的臃肿时代 +**2.5MB** ends the era of FFmpeg's **160MB** bloat -- 🎵 支持 MP3 / FLAC / OGG / WAV -- ⚡ 非阻塞播放，完美适配 GUI 应用 -- 📦 零依赖，纯 Python 调用 -- 🔒 v3.0 LTS 长期支持，永久免费 +- 🎵 Supports MP3 / FLAC / OGG / WAV +- ⚡ Non-blocking playback, perfect for GUI apps +- 📦 Zero dependencies, pure Python +- 🔒 v3.0 LTS long-term support, free forever ```bash pip install ap_ds @@ -69,21 +80,9 @@ pip install ap_ds ```python from ap_ds import AudioLibrary lib = AudioLibrary() -lib.play_from_file("灵感配乐.mp3") # 边写笔记边听歌 +lib.play_from_file("inspiration.mp3") # listen while taking notes ``` -👉 [了解 ap_ds 详情](https://gitcode.com/dvsxt/ap_ds) +👉 [Learn more about ap_ds](https://gitcode.com/dvsxt/ap_ds) -*同一作者出品，同样坚持：轻量、安全、纯粹。* - - - ☁️ CloudNote v1.0 - 端到端加密云笔记 - -📦 作者: dvsxt -📄 许可证: Apache 2.0 -🔗 https://gitcode.com/dvsxt/cloudnote - -🎵 推荐我的项目: ap_ds - 2.5MB 极简音频播放库 - https://gitcode.com/dvsxt/ap_ds +*From the same author, with the same values: lightweight, secure, pure.*