From aebd0e77c35abff61a7ce9114e604ba32a983d57 Mon Sep 17 00:00:00 2001 From: jniesz <64421820+jniesz@users.noreply.github.com> Date: Thu, 3 Nov 2022 02:32:14 -0400 Subject: [PATCH] update README.md doc (#148) Signed-off-by: Jason Niesz Signed-off-by: Jason Niesz --- README.md | 47 ++++++++++++++++------------------------------- 1 file changed, 16 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 0fb9f203..7ba691f9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# L3AFD: Lightweight eBPF Application Foundation Daemon - +# L3AFD: Lightweight eBPF Daemon ![L3AF_Logo](https://github.com/l3af-project/l3af-arch/blob/main/images/logos/Color/L3AF_logo.svg) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6075/badge)](https://bestpractices.coreinfrastructure.org/projects/6075) @@ -7,44 +6,28 @@ L3AFD is a crucial part of the L3AF ecosystem. For more information on L3AF see https://l3af.io/ -# Design - +# Overview L3AFD is the primary component of the L3AF control plane. L3AFD is a daemon -that orchestrates and manages multiple eBPF programs, which we refer to as -Kernel Functions. L3AFD runs on each node where the user wishes to run Kernel -Functions. L3AFD reads configuration data and manages the execution and -monitoring of KFs running on the node. +that orchestrates and manages multiple eBPF programs. L3AFD runs on each node +where the user wishes to run eBPF programs. L3AFD reads configuration data and +manages the execution and monitoring of eBPF programs running on the node. -L3AFD downloads pre-built eBPF programs from a user-configured file repository. -However, we envision the creation of a community-driven Kernel Function -Marketplace where L3AF users can obtain a variety of Kernel Functions developed -by multiple sources. +L3AFD downloads pre-built eBPF programs from a user-configured repository. +However, we envision the creation of a community-driven eBPF package marketplace +where L3AF users can obtain a variety of eBPF programs developed by multiple +sources. ![L3AF Platform](https://github.com/l3af-project/l3af-arch/blob/main/images/L3AF_platform.png) # Try it out - See our [L3AF Development Environment](https://github.com/l3af-project/l3af-arch/tree/main/dev_environment) for a quick and easy way to try out L3AF on your local machine. -# Generate Swagger Docs - -See our [Swaggo setup](docs/swagger.md) +# Installing +Try [a binary release](https://github.com/l3af-project/l3afd/releases/latest). # Building - -To build on your local machine, do the following. - -For Linux: -``` -go build . -``` - -For Windows: -``` -go build -tags WINDOWS . -``` -One can also build and generate swagger docs by doing. +To build on your local machine, including swagger docs do the following. For Linux: ``` @@ -58,7 +41,6 @@ cmake --build build ``` # Testing - To test on your local machine, do the following. For Linux: @@ -70,7 +52,10 @@ For Windows: ``` go test -tags WINDOWS ./... ``` -# Contributing +# Generate Swagger Docs +See our [Swaggo setup](docs/swagger.md) + +# Contributing Contributing to L3afd is fun. To get started: - [Contributing guide](docs/CONTRIBUTING.md)