-
Notifications
You must be signed in to change notification settings - Fork 72
Expand C++ SDK documentation #158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f48dfbf
Move current README.md to docs/building.md
mpwarres b3b6cd4
Add new README and API overview pages.
mpwarres 631b984
Add FFI documentation to api_overview.md
mpwarres 9efbdfc
Add doc comments to header files
mpwarres f6d945f
Fix clang-format
mpwarres cda54bd
Merge branch 'main' into doc
mpwarres 2682cf1
Address review comments.
mpwarres 9152b60
Address review comments.
mpwarres 33acaf0
Address review comments for api_overview.md
mpwarres 4515041
Fix clang-format
mpwarres 9d97f13
Merge branch 'main' into doc
mpwarres File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add new README and API overview pages.
Signed-off-by: Michael Warres <mpw@google.com>
- Loading branch information
commit b3b6cd4a547ca803a4603591e1626e1435bc2f79
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Proxy-Wasm C++ SDK | ||
|
||
[![Build Status][build-badge]][build-link] | ||
[![Apache 2.0 License][license-badge]][license-link] | ||
|
||
Proxy-Wasm is a specification and supporting framework for using | ||
[WebAssembly](https://webassembly.org) (Wasm) to extend the functionality of | ||
network proxies. It enables developers to write custom logic (plugins) that are | ||
compiled to Wasm modules and then loaded and executed by the proxy. | ||
|
||
Proxy-Wasm consists of multiple parts: | ||
|
||
* An [ABI](https://github.com/proxy-wasm/spec) that specifies the low-level | ||
interface between network proxies and Wasm virtual machines that run the | ||
plugins. | ||
* [Host implementations](https://github.com/proxy-wasm/spec#host-environments) | ||
of the ABI, provided by network proxies. | ||
* [Language-specific SDKs](https://github.com/proxy-wasm/spec#sdks) that layer | ||
on top of the ABI, providing a more natural and programmer-friendly API for | ||
invoking and implementing Proxy-Wasm functions and callbacks. | ||
|
||
This repository provides the C++ SDK. | ||
mpwarres marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Getting started | ||
|
||
* Read the [API overview](docs/api_overview.md) to learn about [Proxy-Wasm | ||
concepts] and how they are represented in the C++ SDK. | ||
* View an [example plugin](example/http_wasm_example.cc). | ||
* Refer to [API documentation](docs/api_overview.md#codemap). | ||
* [Build](docs/building.md) plugin code. | ||
|
||
[build-badge]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/workflows/C++/badge.svg?branch=master | ||
[build-link]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/actions?query=workflow%3AC%2B%2B+branch%3Amaster | ||
[license-badge]: https://img.shields.io/github/license/proxy-wasm/proxy-wasm-cpp-sdk | ||
[license-link]: https://github.com/proxy-wasm/proxy-wasm-cpp-sdk/blob/master/LICENSE |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.