update doc (#10)

shalldie · Feb 22, 2024 · 6a4b72c · 6a4b72c
1 parent 54a8613
commit 6a4b72c
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ English | [中文](./README.zh-CN.md)
 
 <img src="https://user-images.githubusercontent.com/9987486/229472271-62a5d923-f7b7-416c-913e-c842ecc2de4d.png" width="320" />
 
-### Cloud Notebook in terminal, based on Github Gist. 🦋
+### Cloud Notebook in terminal, based on Gist. 🦋
 
 `终端中运行的云笔记本，基于 Github Gist 构建。`
 
@@ -32,7 +32,7 @@ English | [中文](./README.zh-CN.md)
 
 - [x] Application 🎯
   - [x] Shortcut keys, mouse operations
-  - [x] Cloud storage persistence
+  - [x] Cloud storage persistence, support Github/Gitee
   - [x] i18n
 - [x] Files
   - [x] Add, delete, check, and modify
@@ -46,17 +46,20 @@ English | [中文](./README.zh-CN.md)
 
 ## Prepare & Config
 
-The application is built on GitHub Gist and requires [applying for an access token](https://github.com/settings/tokens/new), and then add it to the environment variable `TNOTE_GIST_TOKEN`。
+The application is built on gist, support Github/Gitee.
+
+- [Applying for Github access token](https://github.com/settings/tokens/new), and then add it to the environment variable `TNOTE_GIST_TOKEN`。
+- [Applying for Gitee access token](https://github.com/settings/tokens/new), and then add it to the environment variable `TNOTE_GIST_TOKEN`。
 
 ```bash
-# ~/.bashrc
+# ~/.bashrc, github
 export TNOTE_GIST_TOKEN="<your_access_token>"
 ```
 
-| Environment Variable  | Default | Description                                           |
-| :-------------------- | :-----: | :---------------------------------------------------- |
-| `TNOTE_GIST_TOKEN`    |         | `access token` applied for                            |
-| `TNOTE_LANG` / `LANG` | `en_US` | Language preferred, optional values: `en_US`、`zh_CN` |
+| Environment Variable                          | Default | Description                                           |
+| :-------------------------------------------- | :-----: | :---------------------------------------------------- |
+| `TNOTE_GIST_TOKEN` / `TNOTE_GIST_TOKEN_GITEE` |         | `access token` applied for                            |
+| `TNOTE_LANG` / `LANG`                         | `en_US` | Language preferred, optional values: `en_US`、`zh_CN` |
 
 ## Installation
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -11,7 +11,7 @@
 
 <img src="https://user-images.githubusercontent.com/9987486/229472271-62a5d923-f7b7-416c-913e-c842ecc2de4d.png" width="320" />
 
-### Cloud Notebook in terminal, based on Github Gist. 🦋
+### Cloud Notebook in terminal, based on Gist. 🦋
 
 `终端中运行的云笔记本，基于 Github Gist 构建。`
 
@@ -32,7 +32,7 @@
 
 - [x] 应用 🎯
   - [x] 快捷键、鼠标操作
-  - [x] 云端存储持久化
+  - [x] 云端存储持久化，支持 Github/Gitee
   - [x] 国际化
 - [x] 文件
   - [x] 增删查改
@@ -46,17 +46,20 @@
 
 ## 准备&配置
 
-应用基于 github gist 构建，需要去 [申请 access token](https://github.com/settings/tokens/new)，然后添加到环境变量 `TNOTE_GIST_TOKEN`。
+应用基于 gist 构建，支持 Github/Gitee 平台。
+
+- [申请 Github access token](https://github.com/settings/tokens/new)，添加到环境变量 `TNOTE_GIST_TOKEN`。
+- [申请 Gitee access token](https://gitee.com/profile/personal_access_tokens/new)，添加到环境变量 `TNOTE_GIST_TOKEN_GITEE`。
 
 ```bash
-# ~/.bashrc
+# ~/.bashrc, github
 export TNOTE_GIST_TOKEN="<your_access_token>"
 ```
 
-| 环境变量              | 默认值  | 描述                                 |
-| :-------------------- | :-----: | :----------------------------------- |
-| `TNOTE_GIST_TOKEN`    |         | 申请到的 access token                |
-| `TNOTE_LANG` / `LANG` | `en_US` | 使用的语言，可选值：`en_US`、`zh_CN` |
+| 环境变量                                      | 默认值  | 描述                                 |
+| :-------------------------------------------- | :-----: | :----------------------------------- |
+| `TNOTE_GIST_TOKEN` / `TNOTE_GIST_TOKEN_GITEE` |         | 申请到的 access token                |
+| `TNOTE_LANG` / `LANG`                         | `en_US` | 使用的语言，可选值：`en_US`、`zh_CN` |
 
 ## 安装&运行