From 07eb2ac35d59dab02bab1e83d94e6597041ea643 Mon Sep 17 00:00:00 2001 From: Claudio Cicconetti Date: Tue, 8 Oct 2024 08:27:10 +0200 Subject: [PATCH] Update documentation --- README.md | 6 +++--- functions/README.md | 11 ++++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b9b85e43..a7e3532f 100644 --- a/README.md +++ b/README.md @@ -151,12 +151,12 @@ to remain up to date on future developments. | edgeless_function | WebAssembly Rust bindings and function programming model. | | edgeless_http | Utility structures and methods for HTTP bindings. | | edgeless_inabox | Implements a minimal, yet complete, EDGELESS system consisting of an ε-CON, an ε-ORC, an ε-BAL and an edgeless node. This is intended to be used for development/validation purposes. | -| edgeless_node | EDGELESS node with WebAssembly and Container run-times. | +| edgeless_node | EDGELESS node with WebAssembly and [Container](documentation/container-runtime.md) run-times. | | edgeless_orc | Reference implementation of the ε-ORC, supporting deployment annotations and implementing two simple function instance allocation strategies: random and round-robin. Upscaling is not supported: all the functions are deployed as single instances. | | edgeless_systemtests | Tests of EDGELESS components deployed in a system fashion, e.g., interacting through gRPC interfaces. | | edgeless_telemetry | Work-in-progress component that provides telemetry data regarding the EDGELESS operation, also supporting Prometheus agents. | -| examples | Contains several examples showcasing the key features of the EDGELESS reference implementation. | -| [functions](functions/README.md) | Library of functions shipping with the EDGELESS platform and used in the examples. | +| [examples](examples/README.md) | Contains several examples showcasing the key features of the EDGELESS reference implementation. | +| [functions](functions/README.md) | Library of _example functions_ shipping with the EDGELESS platform and used in the examples. | | model | Work-in-progress OCaml model of the EDGELESS system. | | scripts | Collection of scripts | diff --git a/functions/README.md b/functions/README.md index c025787a..63611d04 100644 --- a/functions/README.md +++ b/functions/README.md @@ -1,6 +1,11 @@ -# Library of EDGELESS functions +# Library of example EDGELESS functions -The functions included in this directory are used by the [examples](../examples/README.md) and can serve as a template or starting point to help you write _your_ functions. +The functions included in this directory are used by the +[examples](../examples/README.md) and can serve as a template or starting point to help you write _your_ functions. + +> DISCLAIMER: The functions are provided as examples. They are not fully +> optimized and tested and, thus, they are not meant to be used in production +> services. Use at your own risk. ## How to build the functions @@ -17,4 +22,4 @@ To build *all* the functions you can use this script: ```shell scripts/functions_build.sh -``` +``` \ No newline at end of file