diff --git a/README.md b/README.md index dc132ef..7be7b52 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ A note-taking app dependent on python. The official web version can be found at [https://rethink.run](https://rethink.run). +![image](/img/notes-page.png) + +![editor](/img/editor.png) + ## Install ```shell @@ -30,7 +34,7 @@ pip install -U rethink-note ## Usage -Quickly start the note web service with `rethink.run()`: +Quickly start the note web service with `rethink.run()`, and save your note data locally: ```python import rethink @@ -38,7 +42,7 @@ import rethink rethink.run() ``` -If you need more custom running settings, you can use the parameters of `rethink.run()`: +If you need to customize settings, you can set the parameters in `rethink.run()`: ```python import rethink @@ -52,8 +56,7 @@ rethink.run( ``` All notes will be stored in the path specified by `path`, -and the `.data` folder will be created in the current directory by default. -If you want to create a data folder in another path, you can use the `path` parameter. +and the `.data` folder will be created in your `path` directory. English and Chinese languages are supported, and the default is English `en`. If you want to use Chinese `zh`, you can use `language="zh"` parameter. diff --git a/README_ZH.md b/README_ZH.md index cd58f6c..cccf373 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -17,6 +17,10 @@ 一个依赖于 Python 的笔记应用。 官方网页版可以在 [https://rethink.run](https://rethink.run) 找到。 +![image](/img/notes-page-zh.png) + +![editor](/img/editor-zh.png) + ## 安装 ```shell @@ -31,7 +35,7 @@ pip install -U rethink-note ## 使用 -使用 `rethink.run()` 方式,快速启动笔记 web 服务: +使用 `rethink.run()` 方式,快速启动笔记 web 服务,并将你的笔记数据本地化保存: ```python import rethink diff --git a/img/editor-zh.png b/img/editor-zh.png new file mode 100644 index 0000000..9a2ad8a Binary files /dev/null and b/img/editor-zh.png differ diff --git a/img/editor.png b/img/editor.png new file mode 100644 index 0000000..a6e46ac Binary files /dev/null and b/img/editor.png differ diff --git a/img/notes-page-zh.png b/img/notes-page-zh.png new file mode 100644 index 0000000..6782e40 Binary files /dev/null and b/img/notes-page-zh.png differ diff --git a/img/notes-page.png b/img/notes-page.png new file mode 100644 index 0000000..d098e3b Binary files /dev/null and b/img/notes-page.png differ