Skip to content

Commit 46172db

Browse files
committed
docs(README): update content and improve formatting
- Update project description and features - Reorganize roadmap items with bullet points - Fix typo and improve readability
1 parent 243f9f2 commit 46172db

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.MD

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,33 @@
22

33
CortexLuna 是简易,轻量化的 LLM 框架。建设在 Cordis 之上,与 Langchain 和 Vercel AI SDK 有一些相近的 API。
44

5-
CortexLuna 基于 Langchain 和 Vercel AI SDK 进行派生开发。
5+
CortexLuna 基于 Langchain 和 Vercel AI SDK 派生开发。
6+
7+
## 特性
8+
9+
* 基于 TypeScript 编写,提供大量的类型定义
10+
* 轻量化,易于使用,尽可能少的依赖
11+
* 渐进式 API 设计,随时可集成进你的项目
612

713
## 路线图
814

9-
- [x] 结构化 `prompt` 格式化支持
10-
- [x] `generateText` 和 tool calling 支持
11-
- [x] `generateObject` 支持,结构化输出
12-
- [x] `streamText` 支持,流式输出
13-
- [x] `embed` 支持,获取文本(也可以是其他东西)的向量
14-
- [x] `Provider` 提供器,轮询配置等请求
15-
- [ ] Workflow 工作流支持
16-
- [ ] Vector Store 向量存储和检索
17-
- [ ] Hybrid search, bm25 混合向量查询
15+
* [x] 结构化 `prompt` 格式化支持
16+
* [x] `generateText` 和 tool calling 支持
17+
* [x] `generateObject` 支持,结构化输出
18+
* [x] `streamText` 支持,流式输出
19+
* [x] `embed` 支持,获取文本(也可以是其他东西)的向量
20+
* [x] `Provider` 提供器,轮询配置等请求
21+
* [ ] Workflow 工作流支持
22+
* [ ] Vector Store 向量存储和检索
23+
* [ ] Hybrid search, bm25 混合向量查询
1824

1925
## 我是否应该使用 CortexLuna?
2026

2127
CortexLuna 并不是为了取代 Langchain 或 Vercel AI SDK,而是为了给一部分(像我一样的用户)提供一个更简单,轻量级的 LLM 框架。
2228

2329
由于 Langchain 过于笨重,但是 Vercel AI SDK 的设计又有一些简洁。我尝试将两者结合起来,就形成了 CortexLuna。
2430

25-
> [!TIP]
31+
> [! TIP]
2632
> 请注意,此项目是实验性的,不应该用于生产环境。
2733
2834
## 用法

0 commit comments

Comments
 (0)