about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBaitinq <30861839+Baitinq@users.noreply.github.com>2024-09-01 17:38:35 +0200
committerGitHub <noreply@github.com>2024-09-01 17:38:35 +0200
commitf2b8228c186e26de3d1fce0ca1b8d7c6e79632d1 (patch)
tree7798229d2aa41c7d881d83891c98e2b39709ea30
parentMisc: Serialize file to json in lowercase (diff)
downloadfs-tracer-backend-f2b8228c186e26de3d1fce0ca1b8d7c6e79632d1.tar.gz
fs-tracer-backend-f2b8228c186e26de3d1fce0ca1b8d7c6e79632d1.tar.bz2
fs-tracer-backend-f2b8228c186e26de3d1fce0ca1b8d7c6e79632d1.zip
Update README.md
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index 022a219..dda091f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
-install k3s
-install helmsman
+# fs-tracer-backend
 
-COMMIT_SHA=$(git rev-parse --short HEAD) helmsman --apply -f k8s/helmsman.yml
+This repository contains the backend services for the fs-tracer project, which processes and stores file system modification data collected by the eBPF agent. 
 
-to deploy, execute the ./deploy.sh script (and have the correct env variables)
+## Overview
+
+The backend is composed of several microservices that work together to handle incoming file system events, store them in a database, and provide an API for accessing and managing this data. The services are containerized and deployed using Kubernetes for scalability and reliability.
+
+Related:
+- https://github.com/baitinq/fs-tracer
+- https://github.com/baitinq/fs-tracer-backend