Skip to content

Commit 7eb18ab

Browse files
committed
docs(readme): simplify documentation and update contribution guidelines
- Condensed core features description for better readability - Removed detailed technical explanations from feature list - Simplified open source and contributing section - Removed conventional commits examples from README - Added star history chart to both English and Chinese README - Updated license description to be more concise
1 parent f45026a commit 7eb18ab

2 files changed

Lines changed: 20 additions & 34 deletions

File tree

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818
<strong>FlowLLM: Build LLM applications with ease.</strong><br>
1919
</p>
2020

21-
FlowLLM is a configuration-driven LLM application framework. It uses **Service, Job, Step, and Component** as the core building blocks: declare a workflow as a Job, implement the workflow with ordered Steps, expose the Job through CLI, HTTP, or MCP, and manage long-lived infrastructure such as models, embedding stores, and agent wrappers as Components with unified lifecycle and dependency handling.
21+
FlowLLM is a configuration-driven LLM application framework that organizes workflows, service entrypoints, and long-lived components with **Service, Job, Step, and Component**.
2222

2323
## Core Features
2424

25-
- **Configuration-driven**: Starts from `flowllm/config/default.yaml` by default, with support for `config=/path/to/app.yaml` and dot-notation overrides such as `service.port=8181`.
26-
- **Unified execution path**: `CLI / Client -> Service -> Application -> Job -> Step -> Component`. The service layer exposes capabilities, while business logic lives in Jobs and Steps.
27-
- **Multiple service forms**: HTTP Service exposes `POST /<job_name>` through FastAPI; MCP Service exposes non-streaming Jobs as tools through FastMCP.
28-
- **Sync, streaming, background, and scheduled tasks**: Built-in `base`, `stream`, `background`, and `cron` Job backends.
29-
- **Pluggable components**: Register Steps, Services, Clients, LLMs, Embeddings, Embedding Stores, and Agent Wrappers through the global registry `R`.
30-
- **AgentScope integration**: Built-in AgentScope LLM and Embedding wrappers support OpenAI, DashScope, Anthropic, DeepSeek, Gemini, Moonshot, Ollama, xAI, and other backends.
31-
- **Agent wrapper**: Provides an AgentScope wrapper by default, with an optional Claude Code wrapper for exposing Jobs as tools to agents.
25+
- **Configuration-driven**: Starts from `flowllm/config/default.yaml`, with config files and dot-notation overrides.
26+
- **Unified path**: `CLI / Client -> Service -> Application -> Job -> Step -> Component`.
27+
- **Flexible Jobs**: Supports sync, streaming, background, and scheduled tasks exposed through HTTP or MCP.
28+
- **Pluggable components**: Extend Steps, Services, Clients, LLMs, Embeddings, Embedding Stores, and Agent Wrappers through registry `R`.
3229

3330
<p align="center">
3431
<img src="docs/figure/flowllm-architecture.svg" alt="FlowLLM Architecture" width="92%">
@@ -239,21 +236,17 @@ MCP transport supports `stdio`, `sse`, and `streamable-http`.
239236

240237
## Open Source and Contributing
241238

242-
FlowLLM is open source under the Apache License 2.0. Before submitting changes, read the [contribution guide](docs/en/contributing.md) and the [FlowLLM development skill](skills/flowllm_dev/SKILL.md), then try to run:
239+
FlowLLM is licensed under Apache 2.0. Before contributing, read the [contribution guide](docs/en/contributing.md) and [development skill](skills/flowllm_dev/SKILL.md), then run:
243240

244241
```bash
245242
pre-commit run --all-files
246243
pytest
247244
```
248245

249-
Conventional Commits are recommended, for example:
250-
251-
```text
252-
feat(step): add reverse text demo
253-
fix(config): preserve leading zero strings
254-
docs(zh): update readme
255-
```
256-
257246
## License
258247

259248
This project is open source under the Apache License 2.0. See [LICENSE](./LICENSE) for details.
249+
250+
## Star History
251+
252+
[![Star History Chart](https://api.star-history.com/svg?repos=flowllm-ai/flowllm&type=Date)](https://www.star-history.com/#flowllm-ai/flowllm&Date)

README_ZH.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818
<strong>FlowLLM: 轻松构建 LLM 应用。</strong><br>
1919
</p>
2020

21-
FlowLLM 是一个配置驱动的 LLM 应用框架, **Service、Job、Step、Component** 作为核心构建块:把工作流声明为 Job,用有序 Step 实现流程,通过 CLI、HTTP 或 MCP 暴露 Job,并将模型、Embedding Store、Agent wrapper 等长期存在的基础设施作为 Component 统一管理生命周期和依赖
21+
FlowLLM 是一个配置驱动的 LLM 应用框架, **Service、Job、Step、Component** 组织工作流、服务入口和长期组件
2222

2323
## 核心特性
2424

25-
- **配置驱动**:默认从 `flowllm/config/default.yaml` 启动,也支持 `config=/path/to/app.yaml``service.port=8181` 这类 dot notation 覆盖。
26-
- **统一运行链路**`CLI / Client -> Service -> Application -> Job -> Step -> Component`,服务层只负责暴露能力,业务逻辑沉到 Job 和 Step。
27-
- **多种服务形态**:HTTP Service 基于 FastAPI 暴露 `POST /<job_name>`;MCP Service 基于 FastMCP 将非流式 Job 暴露为工具。
28-
- **同步、流式、后台与定时任务**:内置 `base``stream``background``cron` 四类 Job backend。
29-
- **可插拔组件**:通过全局注册表 `R` 注册 Step、Service、Client、LLM、Embedding、Embedding Store 和 Agent Wrapper。
30-
- **AgentScope 集成**:内置 AgentScope LLM/Embedding wrapper,支持 OpenAI、DashScope、Anthropic、DeepSeek、Gemini、Moonshot、Ollama、xAI 等后端。
31-
- **Agent wrapper**:默认提供 AgentScope wrapper,可选安装 Claude Code wrapper,把 Job 作为工具提供给 Agent。
25+
- **配置驱动**:默认从 `flowllm/config/default.yaml` 启动,支持配置文件和 dot notation 覆盖。
26+
- **统一链路**`CLI / Client -> Service -> Application -> Job -> Step -> Component`
27+
- **多种 Job 形态**:支持同步、流式、后台和定时任务,并可通过 HTTP 或 MCP 暴露。
28+
- **可插拔组件**:通过注册表 `R` 扩展 Step、Service、Client、LLM、Embedding、Embedding Store 和 Agent Wrapper。
3229

3330
<p align="center">
3431
<img src="docs/figure/flowllm-architecture.svg" alt="FlowLLM Architecture" width="92%">
@@ -239,21 +236,17 @@ MCP transport 支持 `stdio`、`sse` 和 `streamable-http`。
239236

240237
## 开源与贡献
241238

242-
FlowLLM 使用 Apache License 2.0 开源。提交改动前建议阅读 [贡献指南](docs/zh/contributing.md) 和 [FlowLLM 开发 Skill](skills/flowllm_dev/SKILL.md),并尽量运行:
239+
FlowLLM 使用 Apache 2.0 许可证。贡献前请阅读 [贡献指南](docs/zh/contributing.md) 和 [开发 Skill](skills/flowllm_dev/SKILL.md),并尽量运行:
243240

244241
```bash
245242
pre-commit run --all-files
246243
pytest
247244
```
248245

249-
建议使用 Conventional Commits,例如:
250-
251-
```text
252-
feat(step): add reverse text demo
253-
fix(config): preserve leading zero strings
254-
docs(zh): update readme
255-
```
256-
257246
## License
258247

259248
This project is open source under the Apache License 2.0. See [LICENSE](./LICENSE) for details.
249+
250+
## Star 历史
251+
252+
[![Star History Chart](https://api.star-history.com/svg?repos=flowllm-ai/flowllm&type=Date)](https://www.star-history.com/#flowllm-ai/flowllm&Date)

0 commit comments

Comments
 (0)