doc: update readme

README.md

@@ -1,8 +1,10 @@
 # Obsidian PDF Annotator
 
-Simple but powerful PDF annotator for Obsidian.
+[中文文档](./README_CN.md)
 
+Simple but powerful PDF annotator for Obsidian.
 
+**Stay tuned when Obsidian merge the pdf.js 4.x version, I will support save the annotations into pdf file.**
 
 ## Features
 
@@ -14,6 +16,10 @@ Simple but powerful PDF annotator for Obsidian.
     - Circle;
     - Rectangle;
   - Add signatures;
+- Currently, it is not possible to save the highlight annotations to the PDF file itself (So I don't support save it into pdf yet), but the annotations are saved in the Obsidian vault. 
+  - Because Obsidian is still using 3.9.0 version of pdf.js, which does not support save highlight annotations to the PDF file itself.
+  - And the highlight annotations is supported in 4.x stage of Pdf.js.
+  - **All the annotations is follow the pdf.js annotations extension format, so it is possible to save it into pdf file in the future.**
 
 ## Installation
 

README_CN.md

@@ -0,0 +1,67 @@
+# Obsidian PDF 注释器
+
+[中文文档](./README_CN.md)
+
+简单但功能强大的 Obsidian PDF 注释工具。
+
+**当 Obsidian 合并 pdf.js 4.x 版本时，我将支持将注释保存到 PDF 文件中，或者保存成 Obsidian 所支持的注释。**
+
+## 功能
+
+- 在 Obsidian 中对 PDF 进行注释；
+	- 高亮文本；
+	- 添加评论；
+	- 添加印章；
+	- 添加图形；
+		- 圆形；
+		- 矩形；
+	- 添加签名；
+- 目前，无法将高亮注释保存到 PDF 文件本身（所以我还不支持将其保存到 PDF），但注释会保存在 Obsidian 的库中。
+	- 因为 Obsidian 目前使用的是 pdf.js 3.9.0 版本，该版本不支持将高亮注释保存到 PDF 文件本身。
+	- 高亮注释功能在 pdf.js 4.x 阶段得到了支持。
+	- **所有的注释都遵循 pdf.js 注释扩展格式，因此将来有可能将其保存到 PDF 文件中。**
+
+## 安装
+
+### BRAT
+
+[BRAT](https://github.com/TfTHacker/obsidian42-brat) 是一个插件，允许用户直接从 GitHub 安装 Obsidian 插件并自动更新。
+
+通过命令：
+
+1. 确保已安装 BRAT
+2. 输入命令 `BRAT: Plugins: Add a beta plugin for testing`
+3. 输入 `Quorafind/Obsidian-PDF-Annotator`
+4. 点击添加插件
+
+通过设置：
+
+1. 确保已安装 BRAT
+2. 转到*设置 > BRAT > Beta 插件列表*
+3. 点击添加 Beta 插件
+4. 输入 `Quorafind/Obsidian-PDF-Annotator`
+5. 点击添加插件
+
+### 手动
+
+选项 1：
+
+1. 转到 [Releases](https://github.com/Quorafind/Obsidian-PDF-Annotator/releases)
+2. 下载最新的 `Obsidian-PDF-Annotator-${version}.zip`
+3. 解压内容
+4. 将内容移动到 /your-vault/.obsidian/plugins/obsidian-PDF-Annotator/
+5. 转到*设置 > 社区插件*
+6. 启用遗留库切换器
+
+选项 2：
+
+1. 转到 [Releases](https://github.com/Quorafind/Obsidian-PDF-Annotator/releases)
+2. 下载最新的 `main.js`、`styles.css` 和 `manifest.json`
+3. 将文件移动到 /your-vault/.obsidian/plugins/obsidian-PDF-Annotator/
+5. 转到*设置 > 社区插件*
+6. 启用遗留库切换器
+
+## 致谢
+
+- 大多数功能来自 [pdf.js annotations extension](https://github.com/Laomai-codefee/pdfjs-annotation-extension)。我只是做了很少的 Obsidian 集成。
+- [pdf.js](https://mozilla.github.io/pdf.js/)

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "pdf-annotator",
 	"name": "Pdf Annotator",
-	"version": "0.0.1",
+	"version": "1.0.0",
 	"minAppVersion": "1.4.0",
 	"description": "Simple PDF annotator.",
 	"author": "Boninall",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pdf-annotator",
-	"version": "0.0.1",
+	"version": "1.0.0",
 	"description": "Simple PDF Annotator",
 	"main": "main.js",
 	"scripts": {

versions.json

@@ -1,3 +1,4 @@
 {
-	"0.0.1": "1.4.0"
+	"0.0.1": "1.4.0",
+	"1.0.0": "1.4.0"
 }