From 9520fe9a198e85b5fd9564f19d1acbc1d7fa4156 Mon Sep 17 00:00:00 2001 From: sunshinesmilelk <1176136681@qq.com> Date: Thu, 17 Oct 2024 00:30:32 +0800 Subject: [PATCH] docs: update readme --- README.md | 5 +++++ README_zh.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index b0e14da7..6aabaa41 100644 --- a/README.md +++ b/README.md @@ -100,13 +100,18 @@ import { LibroJupyterModule } from "@difizen/libro-jupyter"; - Define variables for LLMs, agents, and other dialogue objects based on Langchain, which can be directly used in Prompt Cells. - Extend your own models based on libro-ai. +For more details, please refer to [prompt cell manual](./apps/docs/docs/manual/prompt-cell.md)。 + ![image](./apps/docs/public/prompt_cell.gif) + ### Sql Cell - Supports interaction capabilities for executing SQL commands. - Connect to SQL databases to write SQL code directly in the notebook. +For more details, please refer to [sql cell manual](./apps/docs/docs/manual/sql-cell.md)。 + ![image](./apps/docs/public/sql_cell.gif) ## Technical Architecture diff --git a/README_zh.md b/README_zh.md index ad1283cf..2c655273 100644 --- a/README_zh.md +++ b/README_zh.md @@ -103,6 +103,8 @@ import { LibroJupyterModule } from "@difizen/libro-jupyter"; - 支持选择聊天标识,使得选择该聊天标识的 Prompt Cell 都在一个聊天上下文中。 - 支持 Prompt Cell 保存为一个变量,该变量即为 langchain 的 AIMessage。 +详情请阅读[prompt cell 指南](./apps/docs/docs/manual/prompt-cell.md)。 + ![image](./apps/docs/public/prompt_cell_zh.gif) ### Sql Cell @@ -110,6 +112,8 @@ import { LibroJupyterModule } from "@difizen/libro-jupyter"; - 支持与 sql 的执行交互能力。 - 连接 sql 数据库即可在 notebook 中写 sql 代码。 +详情请阅读[sql cell 指南](./apps/docs/docs/manual/sql-cell.md)。 + ![image](./apps/docs/public/sql_cell_zh.gif) ## 架构