|
| 1 | +# Proxy-Wasm C++ SDK |
| 2 | + |
| 3 | +[![Build Status][build-badge]][build-link] |
| 4 | +[![Apache 2.0 License][license-badge]][license-link] |
| 5 | + |
| 6 | +Proxy-Wasm is a specification and supporting framework for using |
| 7 | +[WebAssembly](https://webassembly.org) (Wasm) to extend the functionality of |
| 8 | +network proxies. It enables developers to write custom logic (plugins) that are |
| 9 | +compiled to Wasm modules and then loaded and executed by the proxy. |
| 10 | + |
| 11 | +Proxy-Wasm consists of multiple parts: |
| 12 | + |
| 13 | +* An [ABI](https://github.com/proxy-wasm/spec) that specifies the low-level |
| 14 | + interface between network proxies and Wasm virtual machines that run the |
| 15 | + plugins. |
| 16 | +* [Host implementations](https://github.com/proxy-wasm/spec#host-environments) |
| 17 | + of the ABI, provided by network proxies. |
| 18 | +* [Language-specific SDKs](https://github.com/proxy-wasm/spec#sdks) that layer |
| 19 | + on top of the ABI, providing a more natural and programmer-friendly API for |
| 20 | + invoking and implementing Proxy-Wasm functions and callbacks. |
| 21 | + |
| 22 | +This repository provides the C++ SDK. |
| 23 | + |
| 24 | +## Getting started |
| 25 | + |
| 26 | +* Read the [API overview](docs/api_overview.md) to learn about [Proxy-Wasm |
| 27 | + concepts] and how they are represented in the C++ SDK. |
| 28 | +* View an [example plugin](example/http_wasm_example.cc). |
| 29 | +* Refer to [API documentation](docs/api_overview.md#codemap). |
| 30 | +* [Build](docs/building.md) plugin code. |
| 31 | + |
| 32 | +[build-badge]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/workflows/C++/badge.svg?branch=master |
| 33 | +[build-link]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/actions?query=workflow%3AC%2B%2B+branch%3Amaster |
| 34 | +[license-badge]: https://img.shields.io/github/license/proxy-wasm/proxy-wasm-cpp-sdk |
| 35 | +[license-link]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/blob/master/LICENSE |
0 commit comments