|
1 | 1 | # Function Stream |
2 | 2 |
|
| 3 | +[中文](README-zh.md) | [English](README.md) |
| 4 | + |
3 | 5 | **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**. |
4 | 6 |
|
| 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 | + |
5 | 26 | ## Key Features |
6 | 27 |
|
7 | 28 | * **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 |
143 | 164 | 3. **Custom Configuration** — Start with a specific config file. |
144 | 165 |
|
145 | 166 | ```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 |
153 | 168 | ``` |
154 | 169 |
|
155 | 170 | ## Maintenance |
|
0 commit comments