Skip to content

Commit 01bc8d0

Browse files
committed
update docs
1 parent 313f115 commit 01bc8d0

2 files changed

Lines changed: 44 additions & 14 deletions

File tree

README-zh.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
# Function Stream
22

3+
[中文](README-zh.md) | [English](README.md)
4+
35
**Function Stream** 是一个基于 Rust 构建的高性能、事件驱动的流处理框架。它提供了一个模块化的运行时,用于编排编译为 **WebAssembly (WASM)** 的 Serverless 风格处理函数,支持使用 **Go、Python 和 Rust** 编写函数。
46

7+
## 目录
8+
9+
- [核心特性](#核心特性)
10+
- [仓库结构](#仓库结构)
11+
- [前置条件](#前置条件)
12+
- [快速开始 (本地开发)](#快速开始-本地开发)
13+
- [1. 初始化环境](#1-初始化环境)
14+
- [2. 构建并运行服务端](#2-构建并运行服务端)
15+
- [3. 运行 CLI](#3-运行-cli)
16+
- [构建与打包](#构建与打包)
17+
- [构建目标](#构建目标)
18+
- [分发 (打包)](#分发-打包)
19+
- [运行分发包](#运行分发包)
20+
- [使用启动脚本](#使用启动脚本-binstart-serversh)
21+
- [维护](#维护)
22+
- [文档](#文档)
23+
- [配置](#配置)
24+
- [许可证](#许可证)
25+
526
## 核心特性
627

728
* **事件驱动的 WASM 运行时**:以接近原生的性能和沙箱隔离的方式执行多语言函数(Go、Python、Rust)。
@@ -143,13 +164,7 @@ function-stream-<version>/
143164
3. **自定义配置** — 使用特定配置文件启动。
144165

145166
```bash
146-
./bin/start-server.sh -d -c /etc/function-stream/prod.yaml
147-
```
148-
149-
4. **环境变量注入** — 在不修改脚本或系统 env 的情况下注入环境变量。
150-
151-
```bash
152-
./bin/start-server.sh -d -D RUST_LOG=debug
167+
./bin/start-server.sh -d -c config/config.yml
153168
```
154169

155170
## 维护

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
# Function Stream
22

3+
[中文](README-zh.md) | [English](README.md)
4+
35
**Function Stream** is a high-performance, event-driven stream processing framework built in Rust. It provides a modular runtime to orchestrate serverless-style processing functions compiled to **WebAssembly (WASM)**, supporting functions written in **Go, Python, and Rust**.
46

7+
## Table of Contents
8+
9+
- [Key Features](#key-features)
10+
- [Repository Layout](#repository-layout)
11+
- [Prerequisites](#prerequisites)
12+
- [Quick Start (Local Development)](#quick-start-local-development)
13+
- [1. Initialize Environment](#1-initialize-environment)
14+
- [2. Build & Run Server](#2-build--run-server)
15+
- [3. Run CLI](#3-run-cli)
16+
- [Building & Packaging](#building--packaging)
17+
- [Build Targets](#build-targets)
18+
- [Distribution (Packaging)](#distribution-packaging)
19+
- [Running the Distribution](#running-the-distribution)
20+
- [Using the Startup Script](#using-the-startup-script-binstart-serversh)
21+
- [Maintenance](#maintenance)
22+
- [Documentation](#documentation)
23+
- [Configuration](#configuration)
24+
- [License](#license)
25+
526
## Key Features
627

728
* **Event-Driven WASM Runtime**: Executes polyglot functions (Go, Python, Rust) with near-native performance and sandboxed isolation.
@@ -143,13 +164,7 @@ We provide a robust shell script to manage the server process, capable of handli
143164
3. **Custom Configuration** — Start with a specific config file.
144165

145166
```bash
146-
./bin/start-server.sh -d -c /etc/function-stream/prod.yaml
147-
```
148-
149-
4. **Environment Variable Injection** — Inject environment variables without modifying the script or system env.
150-
151-
```bash
152-
./bin/start-server.sh -d -D RUST_LOG=debug
167+
./bin/start-server.sh -d -c config/config.yml
153168
```
154169

155170
## Maintenance

0 commit comments

Comments
 (0)